Skip to main content

Module query

Module query 

Source
Expand description

Borrow-scoped broad-phase queries, casts, and character-mover helpers.

Acquire Query from crate::World::query or crate::RecordingSession::query. Both owners issue the same capability type; the sealed access proof carries the permitted activity. On native targets, repeated overlap, cast, and mover queries can reuse ShapeQueryBuffer, RayQueryBuffer, and MoverQueryBuffer so native and mapped storage remain warm together.

Temporary proxies accept at most crate::MAX_SHAPE_PROXY_POINTS points; exceeding that limit returns crate::Error::InvalidArgument before native query activity. Visitor methods bind the complete native result batch first, then stop Rust-side iteration when the visitor returns false.

Structs§

Aabb
Axis-aligned bounding box with f32 coordinates in both precision modes.
ClosestRayCastResult
Complete result of a closest ray cast, including broad-phase traversal statistics.
CollisionPlane
Collision plane input for solve_planes and clip_vector.
MoverPlaneResult
Result item returned by collide_mover.
MoverQueryBuffer
Reusable raw and mapped storage for mover collision planes.
Plane
A collision plane used by Box2D’s character mover helpers.
PlaneSolverResult
Result returned by solve_planes.
Query
A read-only query capability tied to an ordinary world or recording session.
QueryFilter
Filter for queries
RayQueryBuffer
Reusable raw and mapped storage for ray and shape-cast results.
RayResult
Result of a closest ray cast
ShapeQueryBuffer
Reusable raw-and-mapped storage for overlap query results.

Functions§

clip_vector
Clip a velocity or movement vector against solved collision planes.
solve_planes
Solve the translation that best satisfies the supplied mover collision planes.