pub struct ActiveCollisionTypes(/* private fields */);Expand description
Controls which combinations of body types can collide with each other.
By default, Rapier only detects collisions between pairs that make physical sense (e.g., dynamic-dynamic, dynamic-fixed). Use this to customize that behavior.
Most users don’t need to change this - the defaults are correct for normal physics.
§Default behavior
- ✅ Dynamic ↔ Dynamic (moving objects collide)
- ✅ Dynamic ↔ Fixed (moving objects hit walls)
- ✅ Dynamic ↔ Kinematic (moving objects hit platforms)
- ❌ Fixed ↔ Fixed (walls don’t collide with each other - waste of CPU)
- ❌ Kinematic ↔ Kinematic (platforms don’t collide - they’re user-controlled)
- ❌ Kinematic ↔ Fixed (platforms don’t collide with walls)
§Example
// Enable kinematic-kinematic collisions (unusual)
let types = ActiveCollisionTypes::default() | ActiveCollisionTypes::KINEMATIC_KINEMATIC;
collider.set_active_collision_types(types);Implementations§
Source§impl ActiveCollisionTypes
impl ActiveCollisionTypes
Sourcepub const DYNAMIC_DYNAMIC: Self
pub const DYNAMIC_DYNAMIC: Self
Enables dynamic ↔ dynamic collision detection.
Sourcepub const DYNAMIC_KINEMATIC: Self
pub const DYNAMIC_KINEMATIC: Self
Enables dynamic ↔ kinematic collision detection.
Sourcepub const DYNAMIC_FIXED: Self
pub const DYNAMIC_FIXED: Self
Enables dynamic ↔ fixed collision detection.
Sourcepub const KINEMATIC_KINEMATIC: Self
pub const KINEMATIC_KINEMATIC: Self
Enables kinematic ↔ kinematic collision detection (rarely needed).
Sourcepub const KINEMATIC_FIXED: Self
pub const KINEMATIC_FIXED: Self
Enables kinematic ↔ fixed collision detection (rarely needed).
Sourcepub const FIXED_FIXED: Self
pub const FIXED_FIXED: Self
Enables fixed ↔ fixed collision detection (rarely needed).
Source§impl ActiveCollisionTypes
impl ActiveCollisionTypes
Sourcepub const fn bits(&self) -> u16
pub const fn bits(&self) -> u16
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from a bits value.
This method will return None if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u16) -> Self
pub const fn from_bits_retain(bits: u16) -> Self
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None if name is empty or doesn’t
correspond to any named flag.
Sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags
value (&!).
This method is not equivalent to self & !other when other has unknown bits set.
remove won’t truncate other, but the ! operator will.
Sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert when value is true or remove when value is false.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
Sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags
value (&!).
This method is not equivalent to self & !other when other has unknown bits set.
difference won’t truncate other, but the ! operator will.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
Source§impl ActiveCollisionTypes
impl ActiveCollisionTypes
Sourcepub const fn iter(&self) -> Iter<ActiveCollisionTypes>
pub const fn iter(&self) -> Iter<ActiveCollisionTypes>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
Sourcepub const fn iter_names(&self) -> IterNames<ActiveCollisionTypes>
pub const fn iter_names(&self) -> IterNames<ActiveCollisionTypes>
Yield a set of contained named flags values.
This method is like iter, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Source§impl ActiveCollisionTypes
impl ActiveCollisionTypes
Sourcepub fn test(self, rb_type1: RigidBodyType, rb_type2: RigidBodyType) -> bool
pub fn test(self, rb_type1: RigidBodyType, rb_type2: RigidBodyType) -> bool
Test whether contact should be computed between two rigid-bodies with the given types.
Trait Implementations§
Source§impl Binary for ActiveCollisionTypes
impl Binary for ActiveCollisionTypes
Source§impl BitAnd for ActiveCollisionTypes
impl BitAnd for ActiveCollisionTypes
Source§impl BitAndAssign for ActiveCollisionTypes
impl BitAndAssign for ActiveCollisionTypes
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.
Source§impl BitOr for ActiveCollisionTypes
impl BitOr for ActiveCollisionTypes
Source§fn bitor(self, other: ActiveCollisionTypes) -> Self
fn bitor(self, other: ActiveCollisionTypes) -> Self
The bitwise or (|) of the bits in two flags values.
Source§type Output = ActiveCollisionTypes
type Output = ActiveCollisionTypes
| operator.Source§impl BitOrAssign for ActiveCollisionTypes
impl BitOrAssign for ActiveCollisionTypes
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.
Source§impl BitXor for ActiveCollisionTypes
impl BitXor for ActiveCollisionTypes
Source§impl BitXorAssign for ActiveCollisionTypes
impl BitXorAssign for ActiveCollisionTypes
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.
Source§impl Clone for ActiveCollisionTypes
impl Clone for ActiveCollisionTypes
Source§fn clone(&self) -> ActiveCollisionTypes
fn clone(&self) -> ActiveCollisionTypes
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ActiveCollisionTypes
impl Debug for ActiveCollisionTypes
Source§impl Default for ActiveCollisionTypes
impl Default for ActiveCollisionTypes
Source§impl Extend<ActiveCollisionTypes> for ActiveCollisionTypes
impl Extend<ActiveCollisionTypes> for ActiveCollisionTypes
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one)Source§impl Flags for ActiveCollisionTypes
impl Flags for ActiveCollisionTypes
Source§const FLAGS: &'static [Flag<ActiveCollisionTypes>]
const FLAGS: &'static [Flag<ActiveCollisionTypes>]
Source§fn from_bits_retain(bits: u16) -> ActiveCollisionTypes
fn from_bits_retain(bits: u16) -> ActiveCollisionTypes
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true if any unknown bits are set.Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
Source§fn iter_defined_names() -> IterDefinedNames<Self>
fn iter_defined_names() -> IterDefinedNames<Self>
Self::FLAGS.Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|) of the bits in two flags values.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!). Read moreSource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^) of the bits in two flags values.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^) of the bits in two flags values.Source§fn complement(self) -> Self
fn complement(self) -> Self
!) of the bits in a flags value, truncating the result.Source§impl FromIterator<ActiveCollisionTypes> for ActiveCollisionTypes
impl FromIterator<ActiveCollisionTypes> for ActiveCollisionTypes
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.
Source§impl Hash for ActiveCollisionTypes
impl Hash for ActiveCollisionTypes
Source§impl IntoIterator for ActiveCollisionTypes
impl IntoIterator for ActiveCollisionTypes
Source§impl LowerHex for ActiveCollisionTypes
impl LowerHex for ActiveCollisionTypes
Source§impl Not for ActiveCollisionTypes
impl Not for ActiveCollisionTypes
Source§impl Octal for ActiveCollisionTypes
impl Octal for ActiveCollisionTypes
Source§impl PartialEq for ActiveCollisionTypes
impl PartialEq for ActiveCollisionTypes
Source§impl PublicFlags for ActiveCollisionTypes
impl PublicFlags for ActiveCollisionTypes
Source§impl Sub for ActiveCollisionTypes
impl Sub for ActiveCollisionTypes
Source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).
This method is not equivalent to self & !other when other has unknown bits set.
difference won’t truncate other, but the ! operator will.
Source§type Output = ActiveCollisionTypes
type Output = ActiveCollisionTypes
- operator.Source§impl SubAssign for ActiveCollisionTypes
impl SubAssign for ActiveCollisionTypes
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).
This method is not equivalent to self & !other when other has unknown bits set.
difference won’t truncate other, but the ! operator will.
Source§impl UpperHex for ActiveCollisionTypes
impl UpperHex for ActiveCollisionTypes
impl Copy for ActiveCollisionTypes
impl Eq for ActiveCollisionTypes
impl StructuralPartialEq for ActiveCollisionTypes
Auto Trait Implementations§
impl Freeze for ActiveCollisionTypes
impl RefUnwindSafe for ActiveCollisionTypes
impl Send for ActiveCollisionTypes
impl Sync for ActiveCollisionTypes
impl Unpin for ActiveCollisionTypes
impl UnwindSafe for ActiveCollisionTypes
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.