From 291be142a51a57351f2e4e00a889ac059597bbad Mon Sep 17 00:00:00 2001 From: Benjamin Saunders Date: Sat, 28 Aug 2021 13:45:44 -0700 Subject: Clarify coordinate space of TOI query results --- src/pipeline/query_pipeline.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/pipeline/query_pipeline.rs b/src/pipeline/query_pipeline.rs index 160ae07..bd618b7 100644 --- a/src/pipeline/query_pipeline.rs +++ b/src/pipeline/query_pipeline.rs @@ -658,8 +658,9 @@ impl QueryPipeline { /// 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 - /// just a point (the ray origin). + /// This is similar to ray-casting except that we are casting a whole shape instead of just a + /// point (the ray origin). In the resulting `TOI`, witness and normal 1 refer to the world + /// collider, and are in world space. /// /// # Parameters /// * `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. /// + /// In the resulting `TOI`, witness and normal 1 refer to the world collider, and are in world + /// space. + /// /// # Parameters /// * `colliders` - The set of colliders taking part in this pipeline. /// * `shape_motion` - The motion of the shape. -- cgit