Struct rapier2d::pipeline::ActiveEvents
source · pub struct ActiveEvents { /* private fields */ }
Expand description
Flags affecting the events generated for this collider.
Implementations§
source§impl ActiveEvents
impl ActiveEvents
sourcepub const COLLISION_EVENTS: Self = _
pub const COLLISION_EVENTS: Self = _
If set, Rapier will call EventHandler::handle_collision_event
whenever relevant for this collider.
sourcepub const CONTACT_FORCE_EVENTS: Self = _
pub const CONTACT_FORCE_EVENTS: Self = _
If set, Rapier will call EventHandler::handle_contact_force_event
whenever relevant for this collider.
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§
source§impl Binary for ActiveEvents
impl Binary for ActiveEvents
source§impl BitAnd for ActiveEvents
impl BitAnd for ActiveEvents
source§impl BitAndAssign for ActiveEvents
impl BitAndAssign for ActiveEvents
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for ActiveEvents
impl BitOr for ActiveEvents
source§fn bitor(self, other: ActiveEvents) -> Self
fn bitor(self, other: ActiveEvents) -> Self
Returns the union of the two sets of flags.
§type Output = ActiveEvents
type Output = ActiveEvents
|
operator.source§impl BitOrAssign for ActiveEvents
impl BitOrAssign for ActiveEvents
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for ActiveEvents
impl BitXor for ActiveEvents
source§impl BitXorAssign for ActiveEvents
impl BitXorAssign for ActiveEvents
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ActiveEvents
impl Clone for ActiveEvents
source§fn clone(&self) -> ActiveEvents
fn clone(&self) -> ActiveEvents
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ActiveEvents
impl Debug for ActiveEvents
source§impl Default for ActiveEvents
impl Default for ActiveEvents
source§impl<'de> Deserialize<'de> for ActiveEvents
impl<'de> Deserialize<'de> for ActiveEvents
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl Extend<ActiveEvents> for ActiveEvents
impl Extend<ActiveEvents> for ActiveEvents
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 From<ActiveEvents> for ColliderFlags
impl From<ActiveEvents> for ColliderFlags
source§fn from(active_events: ActiveEvents) -> Self
fn from(active_events: ActiveEvents) -> Self
source§impl FromIterator<ActiveEvents> for ActiveEvents
impl FromIterator<ActiveEvents> for ActiveEvents
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for ActiveEvents
impl Hash for ActiveEvents
source§impl LowerHex for ActiveEvents
impl LowerHex for ActiveEvents
source§impl Not for ActiveEvents
impl Not for ActiveEvents
source§impl Octal for ActiveEvents
impl Octal for ActiveEvents
source§impl Ord for ActiveEvents
impl Ord for ActiveEvents
source§fn cmp(&self, other: &ActiveEvents) -> Ordering
fn cmp(&self, other: &ActiveEvents) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for ActiveEvents
impl PartialEq for ActiveEvents
source§fn eq(&self, other: &ActiveEvents) -> bool
fn eq(&self, other: &ActiveEvents) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for ActiveEvents
impl PartialOrd for ActiveEvents
source§fn partial_cmp(&self, other: &ActiveEvents) -> Option<Ordering>
fn partial_cmp(&self, other: &ActiveEvents) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for ActiveEvents
impl Serialize for ActiveEvents
source§impl Sub for ActiveEvents
impl Sub for ActiveEvents
source§impl SubAssign for ActiveEvents
impl SubAssign for ActiveEvents
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for ActiveEvents
impl UpperHex for ActiveEvents
impl Copy for ActiveEvents
impl Eq for ActiveEvents
impl StructuralPartialEq for ActiveEvents
Auto Trait Implementations§
impl Freeze for ActiveEvents
impl RefUnwindSafe for ActiveEvents
impl Send for ActiveEvents
impl Sync for ActiveEvents
impl Unpin for ActiveEvents
impl UnwindSafe for ActiveEvents
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> 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>
. Box<dyn Any>
can
then be further downcast
into Box<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>
. Rc<Any>
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> DowncastSync for T
impl<T> DowncastSync for T
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<T> Pointable for T
impl<T> Pointable for T
source§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.