Rename raycasting and shapecasting methods in SpatialQuery
#269
+174
−37
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_ray
ray_hits
ray_hits_callback
cast_shape
shape_hits
shape_hits_callback
While these are fine, they could be improved. The distinction between
cast_ray
andray_hits
isn't immediately obvious from the name, and the naming isn't very consistent. In addition, a more common and perhaps cleaner name forcast_ray
israycast
.Solution
Rename the methods to be cleaner and more consistent:
cast_ray
→raycast
ray_hits
→raycast_many
ray_hits_callback
→raycast_callback
cast_shape
→shapecast
shape_hits
→shapecast_many
shape_hits_callback
→shapecast_callback
The old methods still exist, but have been deprecated and will be removed after the next release.
Migration Guide