Struct rapier3d::geometry::CollisionEventFlags
source · [−]pub struct CollisionEventFlags { /* private fields */ }
Expand description
Flags providing more information regarding a collision event.
Implementations
sourceimpl CollisionEventFlags
impl CollisionEventFlags
sourcepub const SENSOR: Self = Self{bits: 1,}
pub const SENSOR: Self = Self{bits: 1,}
Flag set if at least one of the colliders involved in the collision was a sensor when the event was fired.
sourcepub const REMOVED: Self = Self{bits: 2,}
pub const REMOVED: Self = Self{bits: 2,}
Flag set if a CollisionEvent::Stopped
was fired because
at least one of the colliders was removed.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for CollisionEventFlags
impl Binary for CollisionEventFlags
sourceimpl BitAnd<CollisionEventFlags> for CollisionEventFlags
impl BitAnd<CollisionEventFlags> for CollisionEventFlags
type Output = CollisionEventFlags
type Output = CollisionEventFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<CollisionEventFlags> for CollisionEventFlags
impl BitAndAssign<CollisionEventFlags> for CollisionEventFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<CollisionEventFlags> for CollisionEventFlags
impl BitOr<CollisionEventFlags> for CollisionEventFlags
sourcefn bitor(self, other: CollisionEventFlags) -> Self
fn bitor(self, other: CollisionEventFlags) -> Self
Returns the union of the two sets of flags.
type Output = CollisionEventFlags
type Output = CollisionEventFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<CollisionEventFlags> for CollisionEventFlags
impl BitOrAssign<CollisionEventFlags> for CollisionEventFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<CollisionEventFlags> for CollisionEventFlags
impl BitXor<CollisionEventFlags> for CollisionEventFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = CollisionEventFlags
type Output = CollisionEventFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<CollisionEventFlags> for CollisionEventFlags
impl BitXorAssign<CollisionEventFlags> for CollisionEventFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for CollisionEventFlags
impl Clone for CollisionEventFlags
sourcefn clone(&self) -> CollisionEventFlags
fn clone(&self) -> CollisionEventFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CollisionEventFlags
impl Debug for CollisionEventFlags
sourceimpl Extend<CollisionEventFlags> for CollisionEventFlags
impl Extend<CollisionEventFlags> for CollisionEventFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<CollisionEventFlags> for CollisionEventFlags
impl FromIterator<CollisionEventFlags> for CollisionEventFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for CollisionEventFlags
impl Hash for CollisionEventFlags
sourceimpl LowerHex for CollisionEventFlags
impl LowerHex for CollisionEventFlags
sourceimpl Not for CollisionEventFlags
impl Not for CollisionEventFlags
type Output = CollisionEventFlags
type Output = CollisionEventFlags
The resulting type after applying the !
operator.
sourceimpl Octal for CollisionEventFlags
impl Octal for CollisionEventFlags
sourceimpl Ord for CollisionEventFlags
impl Ord for CollisionEventFlags
sourceimpl PartialEq<CollisionEventFlags> for CollisionEventFlags
impl PartialEq<CollisionEventFlags> for CollisionEventFlags
sourcefn eq(&self, other: &CollisionEventFlags) -> bool
fn eq(&self, other: &CollisionEventFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CollisionEventFlags) -> bool
fn ne(&self, other: &CollisionEventFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<CollisionEventFlags> for CollisionEventFlags
impl PartialOrd<CollisionEventFlags> for CollisionEventFlags
sourcefn partial_cmp(&self, other: &CollisionEventFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &CollisionEventFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<CollisionEventFlags> for CollisionEventFlags
impl Sub<CollisionEventFlags> for CollisionEventFlags
type Output = CollisionEventFlags
type Output = CollisionEventFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<CollisionEventFlags> for CollisionEventFlags
impl SubAssign<CollisionEventFlags> for CollisionEventFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for CollisionEventFlags
impl UpperHex for CollisionEventFlags
impl Copy for CollisionEventFlags
impl Eq for CollisionEventFlags
impl StructuralEq for CollisionEventFlags
impl StructuralPartialEq for CollisionEventFlags
Auto Trait Implementations
impl RefUnwindSafe for CollisionEventFlags
impl Send for CollisionEventFlags
impl Sync for CollisionEventFlags
impl Unpin for CollisionEventFlags
impl UnwindSafe for CollisionEventFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
sourcefn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
sourcefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
sourcefn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
sourcefn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more