nichkara/rapier
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Fix minor typos and tweaks (#696)

Browse Source 
---------

Co-authored-by: Thierry Berger <contact@thierryberger.com>
This commit is contained in:
Bruce Mitchener
2024-07-22 16:32:08 +07:00
committed by GitHub
parent cf74150763
commit 7374653338
7 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/geometry/broad_phase_multi_sap/sap_utils.rs
View File

@@ -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;