diff options
| author | Bruce Mitchener <bruce.mitchener@gmail.com> | 2024-07-22 16:32:08 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-07-22 11:32:08 +0200 |
| commit | 7374653338cf1a2669aa8b072ff5376262149474 (patch) | |
| tree | f57db02a6f9323351bfc1a246381d4973b04ca9f /src/geometry/broad_phase_multi_sap | |
| parent | cf74150763dd575bc0399087e845e9be62aba56f (diff) | |
| download | rapier-7374653338cf1a2669aa8b072ff5376262149474.tar.gz rapier-7374653338cf1a2669aa8b072ff5376262149474.tar.bz2 rapier-7374653338cf1a2669aa8b072ff5376262149474.zip | |
docs: Fix minor typos and tweaks (#696)
---------
Co-authored-by: Thierry Berger <contact@thierryberger.com>
Diffstat (limited to 'src/geometry/broad_phase_multi_sap')
| -rw-r--r-- | src/geometry/broad_phase_multi_sap/sap_utils.rs | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/geometry/broad_phase_multi_sap/sap_utils.rs b/src/geometry/broad_phase_multi_sap/sap_utils.rs index 56183eb..a8356ad 100644 --- a/src/geometry/broad_phase_multi_sap/sap_utils.rs +++ b/src/geometry/broad_phase_multi_sap/sap_utils.rs @@ -40,15 +40,15 @@ pub(crate) fn region_width(depth: i8) -> Real { (REGION_WIDTH_BASE * REGION_WIDTH_POWER_BASIS.powi(depth as i32)).min(MAX_AABB_EXTENT) } -/// Computes the depth of the layer the given Aabb should be part of. +/// Computes the depth of the layer the given [`Aabb`] should be part of. /// -/// The idea here is that an Aabb should be part of a layer which has -/// regions large enough so that one Aabb doesn't crosses too many +/// The idea here is that an [`Aabb`] should be part of a layer which has +/// regions large enough so that one [`Aabb`] doesn't crosses too many /// regions. But the regions must also not be too large, otherwise /// we are loosing the benefits of Multi-SAP. /// -/// If the code bellow, we select a layer such that each region can -/// contain at least a chain of 10 contiguous objects with that Aabb. +/// If the code below, we select a layer such that each region can +/// contain at least a chain of 10 contiguous objects with that [`Aabb`]. pub(crate) fn layer_containing_aabb(aabb: &Aabb) -> i8 { // Max number of elements of this size we would like one region to be able to contain. const NUM_ELEMENTS_PER_DIMENSION: Real = 10.0; |
