aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorSébastien Crozet <developer@crozet.re>2021-02-14 10:20:56 +0100
committerGitHub <noreply@github.com>2021-02-14 10:20:56 +0100
commit12c5dd4caa6af5750b682ba17229601e3a418155 (patch)
tree0808d9ff7c530073086efb075c94f632344d6dc9 /src
parent3be866920657f7a13a49486795e06f14d92f4969 (diff)
parent365426555c5d2887b25c7568ea1d1812eb631ebd (diff)
downloadrapier-12c5dd4caa6af5750b682ba17229601e3a418155.tar.gz
rapier-12c5dd4caa6af5750b682ba17229601e3a418155.tar.bz2
rapier-12c5dd4caa6af5750b682ba17229601e3a418155.zip
Merge pull request #112 from alec-deason/typo
Fix a small documentation typo on InteractionGroups
Diffstat (limited to 'src')
-rw-r--r--src/geometry/interaction_groups.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/geometry/interaction_groups.rs b/src/geometry/interaction_groups.rs
index 48808de..37b7586 100644
--- a/src/geometry/interaction_groups.rs
+++ b/src/geometry/interaction_groups.rs
@@ -7,10 +7,11 @@
/// - The interaction groups (the 16 left-most bits of `self.0`).
/// - The interaction mask (the 16 right-most bits of `self.0`).
///
-/// An interaction is allowed between two filters `a` and `b` two conditions
+/// An interaction is allowed between two filters `a` and `b` when two conditions
/// are met simultaneously:
/// - The interaction groups of `a` has at least one bit set to `1` in common with the interaction mask of `b`.
/// - The interaction groups of `b` has at least one bit set to `1` in common with the interaction mask of `a`.
+///
/// In other words, interactions are allowed between two filter iff. the following condition is met:
/// ```ignore
/// ((self.0 >> 16) & rhs.0) != 0 && ((rhs.0 >> 16) & self.0) != 0