Skip to content

Contact doc fixes#4

Open
ThierryBerger wants to merge 3 commits intodimforge:mainfrom
ThierryBerger:fix-contact-doc
Open

Contact doc fixes#4
ThierryBerger wants to merge 3 commits intodimforge:mainfrom
ThierryBerger:fix-contact-doc

Conversation

@ThierryBerger
Copy link
Contributor

No description provided.

@ThierryBerger ThierryBerger requested a review from sebcrozet July 4, 2025 14:07
@github-actions
Copy link

github-actions bot commented Jul 4, 2025

Comparison Result

View workflow run details

Userguide diff introduced by this PR

diff -r /tmp/target_generated/geometric_queries.mdx /tmp/pr_generated/geometric_queries.mdx
432,436c432,436
< | `world1` | The contact point on the first object expressed in the absolute coordinate system. |
< | `world2` | The contact point on the second object expressed in the absolute coordinate system. |
< | `normal1` | { /* TODO: it's not always in world space... */} The contact normal expressed in the absolute coordinate system. Points toward the first object's exterior. |
< | `normal2` | The contact normal expressed in the absolute coordinate system. Points toward the second object's exterior. If these contact data are expressed in world-space, this normal is equal to -normal1. |
< | `depth`  | The penetration depth of this contact. |
---
> | `point1` | Position of the contact on the first object. |
> | `point2` | Position of the contact on the second object. |
> | `normal1` | Contact normal, pointing towards the exterior of the first shape. |
> | `normal2` | Contact normal, pointing towards the exterior of the second shape. If these contact data are expressed in world-space, this normal is equal to `-normal1`. |
> | `dist`  | The penetration depth of this contact. If this is negative, this contact represents a penetration. |
437a438
> :::warning
439,440c440,446
< Here, _absolute coordinate system_ is the set of axes that are not relative
< to any object. The last `depth` field requires some details. Sometimes, the
---
> In context of `query::contact`, `point1` and `point2` are expressed in _absolute coordinates_: which are not relative
> to any object. But when using lower level functions like `contact_cuboid_cuboid`
> (typically functions taking a `pos12: &Isometry<f32>`), `point1` and `point2` are expressed in _local coordinates_ to each `Shape` arguments.
> 
> :::
> 
> The last `dist` field requires some details. Sometimes, the

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant