diff options
| author | Benjamin Saunders <ben.e.saunders@gmail.com> | 2021-08-28 13:45:44 -0700 |
|---|---|---|
| committer | Sébastien Crozet <sebastien@crozet.re> | 2021-08-30 10:12:59 +0200 |
| commit | 291be142a51a57351f2e4e00a889ac059597bbad (patch) | |
| tree | e6b6a8cc1771a65d52e51443936588133e684896 | |
| parent | 29462e29687dfcd097a6f8f4094c96c3c414b026 (diff) | |
| download | rapier-291be142a51a57351f2e4e00a889ac059597bbad.tar.gz rapier-291be142a51a57351f2e4e00a889ac059597bbad.tar.bz2 rapier-291be142a51a57351f2e4e00a889ac059597bbad.zip | |
Clarify coordinate space of TOI query results
| -rw-r--r-- | src/pipeline/query_pipeline.rs | 8 |
1 files 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. |