Rename raycasting and shapecasting methods in SpatialQuery#269
Open
Rename raycasting and shapecasting methods in SpatialQuery#269
SpatialQuery#269Conversation
Member
|
Marking as Waiting-on-Author due to merge conflicts |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objective
Currently, the following names are used for raycasting/shapecasting methods:
cast_rayray_hitsray_hits_callbackcast_shapeshape_hitsshape_hits_callbackWhile these are fine, they could be improved. The distinction between
cast_rayandray_hitsisn't immediately obvious from the name, and the naming isn't very consistent. In addition, a more common and perhaps cleaner name forcast_rayisraycast.Solution
Rename the methods to be cleaner and more consistent:
cast_ray→raycastray_hits→raycast_manyray_hits_callback→raycast_callbackcast_shape→shapecastshape_hits→shapecast_manyshape_hits_callback→shapecast_callbackThe old methods still exist, but have been deprecated and will be removed after the next release.
Migration Guide