Clarify coordinate space of TOI query results
This commit is contained in:
committed by
Sébastien Crozet
parent
29462e2968
commit
291be142a5
@@ -658,8 +658,9 @@ impl QueryPipeline {
|
|||||||
|
|
||||||
/// Casts a shape at a constant linear velocity and retrieve the first collider it hits.
|
/// Casts a shape at a constant linear velocity and retrieve the first collider it hits.
|
||||||
///
|
///
|
||||||
/// This is similar to ray-casting except that we are casting a whole shape instead of
|
/// This is similar to ray-casting except that we are casting a whole shape instead of just a
|
||||||
/// just a point (the ray origin).
|
/// point (the ray origin). In the resulting `TOI`, witness and normal 1 refer to the world
|
||||||
|
/// collider, and are in world space.
|
||||||
///
|
///
|
||||||
/// # Parameters
|
/// # Parameters
|
||||||
/// * `colliders` - The set of colliders taking part in this pipeline.
|
/// * `colliders` - The set of colliders taking part in this pipeline.
|
||||||
@@ -702,6 +703,9 @@ impl QueryPipeline {
|
|||||||
|
|
||||||
/// Casts a shape with an arbitrary continuous motion and retrieve the first collider it hits.
|
/// Casts a shape with an arbitrary continuous motion and retrieve the first collider it hits.
|
||||||
///
|
///
|
||||||
|
/// In the resulting `TOI`, witness and normal 1 refer to the world collider, and are in world
|
||||||
|
/// space.
|
||||||
|
///
|
||||||
/// # Parameters
|
/// # Parameters
|
||||||
/// * `colliders` - The set of colliders taking part in this pipeline.
|
/// * `colliders` - The set of colliders taking part in this pipeline.
|
||||||
/// * `shape_motion` - The motion of the shape.
|
/// * `shape_motion` - The motion of the shape.
|
||||||
|
|||||||
Reference in New Issue
Block a user