Struct rapier2d::geometry::ColliderChanges
source · [−]pub struct ColliderChanges { /* private fields */ }
Expand description
Flags describing how the collider has been modified by the user.
Implementations
sourceimpl ColliderChanges
impl ColliderChanges
sourcepub const MODIFIED: Self = Self{bits: 1 << 0,}
pub const MODIFIED: Self = Self{bits: 1 << 0,}
Flag indicating that any component of the collider has been modified.
sourcepub const PARENT: Self = Self{bits: 1 << 1,}
pub const PARENT: Self = Self{bits: 1 << 1,}
Flag indicating that the ColliderParent
component of the collider has been modified.
sourcepub const POSITION: Self = Self{bits: 1 << 2,}
pub const POSITION: Self = Self{bits: 1 << 2,}
Flag indicating that the ColliderPosition
component of the collider has been modified.
sourcepub const GROUPS: Self = Self{bits: 1 << 3,}
pub const GROUPS: Self = Self{bits: 1 << 3,}
Flag indicating that the collision groups of the collider have been modified.
sourcepub const SHAPE: Self = Self{bits: 1 << 4,}
pub const SHAPE: Self = Self{bits: 1 << 4,}
Flag indicating that the ColliderShape
component of the collider has been modified.
sourcepub const TYPE: Self = Self{bits: 1 << 5,}
pub const TYPE: Self = Self{bits: 1 << 5,}
Flag indicating that the ColliderType
component of the collider has been modified.
sourcepub const PARENT_EFFECTIVE_DOMINANCE: Self = Self{bits: 1 << 6,}
pub const PARENT_EFFECTIVE_DOMINANCE: Self = Self{bits: 1 << 6,}
Flag indicating that the dominance groups of the parent of this collider have been modified.
This flags is automatically set by the PhysicsPipeline
when the RigidBodyChanges::DOMINANCE
or RigidBodyChanges::TYPE
of the parent rigid-body of this collider is detected.
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
.
sourceimpl ColliderChanges
impl ColliderChanges
sourcepub fn needs_broad_phase_update(self) -> bool
pub fn needs_broad_phase_update(self) -> bool
Do these changes justify a broad-phase update?
sourcepub fn needs_narrow_phase_update(self) -> bool
pub fn needs_narrow_phase_update(self) -> bool
Do these changes justify a narrow-phase update?
Trait Implementations
sourceimpl Binary for ColliderChanges
impl Binary for ColliderChanges
sourceimpl BitAnd<ColliderChanges> for ColliderChanges
impl BitAnd<ColliderChanges> for ColliderChanges
type Output = ColliderChanges
type Output = ColliderChanges
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<ColliderChanges> for ColliderChanges
impl BitAndAssign<ColliderChanges> for ColliderChanges
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ColliderChanges> for ColliderChanges
impl BitOr<ColliderChanges> for ColliderChanges
sourcefn bitor(self, other: ColliderChanges) -> Self
fn bitor(self, other: ColliderChanges) -> Self
Returns the union of the two sets of flags.
type Output = ColliderChanges
type Output = ColliderChanges
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ColliderChanges> for ColliderChanges
impl BitOrAssign<ColliderChanges> for ColliderChanges
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ColliderChanges> for ColliderChanges
impl BitXor<ColliderChanges> for ColliderChanges
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 = ColliderChanges
type Output = ColliderChanges
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<ColliderChanges> for ColliderChanges
impl BitXorAssign<ColliderChanges> for ColliderChanges
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ColliderChanges
impl Clone for ColliderChanges
sourcefn clone(&self) -> ColliderChanges
fn clone(&self) -> ColliderChanges
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 ColliderChanges
impl Debug for ColliderChanges
sourceimpl Default for ColliderChanges
impl Default for ColliderChanges
sourceimpl Extend<ColliderChanges> for ColliderChanges
impl Extend<ColliderChanges> for ColliderChanges
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<ColliderChanges> for ColliderChanges
impl FromIterator<ColliderChanges> for ColliderChanges
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 ColliderChanges
impl Hash for ColliderChanges
sourceimpl LowerHex for ColliderChanges
impl LowerHex for ColliderChanges
sourceimpl Not for ColliderChanges
impl Not for ColliderChanges
type Output = ColliderChanges
type Output = ColliderChanges
The resulting type after applying the !
operator.
sourceimpl Octal for ColliderChanges
impl Octal for ColliderChanges
sourceimpl Ord for ColliderChanges
impl Ord for ColliderChanges
sourceimpl PartialEq<ColliderChanges> for ColliderChanges
impl PartialEq<ColliderChanges> for ColliderChanges
sourcefn eq(&self, other: &ColliderChanges) -> bool
fn eq(&self, other: &ColliderChanges) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ColliderChanges) -> bool
fn ne(&self, other: &ColliderChanges) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ColliderChanges> for ColliderChanges
impl PartialOrd<ColliderChanges> for ColliderChanges
sourcefn partial_cmp(&self, other: &ColliderChanges) -> Option<Ordering>
fn partial_cmp(&self, other: &ColliderChanges) -> 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<ColliderChanges> for ColliderChanges
impl Sub<ColliderChanges> for ColliderChanges
type Output = ColliderChanges
type Output = ColliderChanges
The resulting type after applying the -
operator.
sourceimpl SubAssign<ColliderChanges> for ColliderChanges
impl SubAssign<ColliderChanges> for ColliderChanges
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for ColliderChanges
impl UpperHex for ColliderChanges
impl Copy for ColliderChanges
impl Eq for ColliderChanges
impl StructuralEq for ColliderChanges
impl StructuralPartialEq for ColliderChanges
Auto Trait Implementations
impl RefUnwindSafe for ColliderChanges
impl Send for ColliderChanges
impl Sync for ColliderChanges
impl Unpin for ColliderChanges
impl UnwindSafe for ColliderChanges
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