Struct rapier3d::pipeline::ActiveEvents
source · [−]pub struct ActiveEvents { /* private fields */ }
Expand description
Flags affecting the events generated for this collider.
Implementations
sourceimpl ActiveEvents
impl ActiveEvents
sourcepub const COLLISION_EVENTS: Self = Self{bits: 1,}
pub const COLLISION_EVENTS: Self = Self{bits: 1,}
If set, Rapier will call EventHandler::handle_intersection_event
and
EventHandler::handle_contact_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
sourceimpl Binary for ActiveEvents
impl Binary for ActiveEvents
sourceimpl BitAnd<ActiveEvents> for ActiveEvents
impl BitAnd<ActiveEvents> for ActiveEvents
type Output = ActiveEvents
type Output = ActiveEvents
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<ActiveEvents> for ActiveEvents
impl BitAndAssign<ActiveEvents> for ActiveEvents
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ActiveEvents> for ActiveEvents
impl BitOr<ActiveEvents> for ActiveEvents
sourcefn 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
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ActiveEvents> for ActiveEvents
impl BitOrAssign<ActiveEvents> for ActiveEvents
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ActiveEvents> for ActiveEvents
impl BitXor<ActiveEvents> for ActiveEvents
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 = ActiveEvents
type Output = ActiveEvents
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<ActiveEvents> for ActiveEvents
impl BitXorAssign<ActiveEvents> for ActiveEvents
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ActiveEvents
impl Clone for ActiveEvents
sourcefn clone(&self) -> ActiveEvents
fn clone(&self) -> ActiveEvents
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 ActiveEvents
impl Debug for ActiveEvents
sourceimpl Default for ActiveEvents
impl Default for ActiveEvents
sourceimpl Extend<ActiveEvents> for ActiveEvents
impl Extend<ActiveEvents> for ActiveEvents
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 From<ActiveEvents> for ColliderFlags
impl From<ActiveEvents> for ColliderFlags
sourcefn from(active_events: ActiveEvents) -> Self
fn from(active_events: ActiveEvents) -> Self
Converts to this type from the input type.
sourceimpl FromIterator<ActiveEvents> for ActiveEvents
impl FromIterator<ActiveEvents> for ActiveEvents
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 ActiveEvents
impl Hash for ActiveEvents
sourceimpl LowerHex for ActiveEvents
impl LowerHex for ActiveEvents
sourceimpl Not for ActiveEvents
impl Not for ActiveEvents
type Output = ActiveEvents
type Output = ActiveEvents
The resulting type after applying the !
operator.
sourceimpl Octal for ActiveEvents
impl Octal for ActiveEvents
sourceimpl Ord for ActiveEvents
impl Ord for ActiveEvents
sourceimpl PartialEq<ActiveEvents> for ActiveEvents
impl PartialEq<ActiveEvents> for ActiveEvents
sourcefn eq(&self, other: &ActiveEvents) -> bool
fn eq(&self, other: &ActiveEvents) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ActiveEvents) -> bool
fn ne(&self, other: &ActiveEvents) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ActiveEvents> for ActiveEvents
impl PartialOrd<ActiveEvents> for ActiveEvents
sourcefn partial_cmp(&self, other: &ActiveEvents) -> Option<Ordering>
fn partial_cmp(&self, other: &ActiveEvents) -> 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<ActiveEvents> for ActiveEvents
impl Sub<ActiveEvents> for ActiveEvents
type Output = ActiveEvents
type Output = ActiveEvents
The resulting type after applying the -
operator.
sourceimpl SubAssign<ActiveEvents> for ActiveEvents
impl SubAssign<ActiveEvents> for ActiveEvents
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for ActiveEvents
impl UpperHex for ActiveEvents
impl Copy for ActiveEvents
impl Eq for ActiveEvents
impl StructuralEq for ActiveEvents
impl StructuralPartialEq for ActiveEvents
Auto Trait Implementations
impl RefUnwindSafe for ActiveEvents
impl Send for ActiveEvents
impl Sync for ActiveEvents
impl Unpin for ActiveEvents
impl UnwindSafe for ActiveEvents
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