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 = _
pub const SENSOR: Self = _
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 = _
pub const REMOVED: Self = _
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
&
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
|
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
^
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
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl 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)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)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
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
!
operator.sourceimpl Octal for CollisionEventFlags
impl Octal for CollisionEventFlags
sourceimpl Ord for CollisionEventFlags
impl Ord for CollisionEventFlags
sourcefn cmp(&self, other: &CollisionEventFlags) -> Ordering
fn cmp(&self, other: &CollisionEventFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialEq<CollisionEventFlags> for CollisionEventFlags
impl PartialEq<CollisionEventFlags> for CollisionEventFlags
sourcefn eq(&self, other: &CollisionEventFlags) -> bool
fn eq(&self, other: &CollisionEventFlags) -> bool
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>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Sub<CollisionEventFlags> for CollisionEventFlags
impl Sub<CollisionEventFlags> for CollisionEventFlags
type Output = CollisionEventFlags
type Output = CollisionEventFlags
-
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 Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
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>
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 moresourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresourcefn 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. Read moresourcefn 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. Read moresourceimpl<T> DowncastSync for Twhere
T: Any + Send + Sync,
impl<T> DowncastSync for Twhere
T: Any + Send + Sync,
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
sourcefn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresourcefn 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).sourcefn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.sourcefn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.