Struct physx_sys::PxPairFlags
source · pub struct PxPairFlags { /* private fields */ }
Expand description
Flags for PxPairFlag
Implementations§
source§impl PxPairFlags
impl PxPairFlags
pub const SolveContact: Self = _
pub const ModifyContacts: Self = _
pub const NotifyTouchFound: Self = _
pub const NotifyTouchPersists: Self = _
pub const NotifyTouchLost: Self = _
pub const NotifyTouchCcd: Self = _
pub const NotifyThresholdForceFound: Self = _
pub const NotifyThresholdForcePersists: Self = _
pub const NotifyThresholdForceLost: Self = _
pub const NotifyContactPoints: Self = _
pub const DetectDiscreteContact: Self = _
pub const DetectCcdContact: Self = _
pub const PreSolverVelocity: Self = _
pub const PostSolverVelocity: Self = _
pub const ContactEventPose: Self = _
pub const NextFree: Self = _
pub const ContactDefault: Self = _
pub const TriggerDefault: Self = _
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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 PxPairFlags
impl Binary for PxPairFlags
source§impl BitAnd for PxPairFlags
impl BitAnd for PxPairFlags
source§impl BitAndAssign for PxPairFlags
impl BitAndAssign for PxPairFlags
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 PxPairFlags
impl BitOr for PxPairFlags
source§fn bitor(self, other: PxPairFlags) -> Self
fn bitor(self, other: PxPairFlags) -> Self
Returns the union of the two sets of flags.
§type Output = PxPairFlags
type Output = PxPairFlags
|
operator.source§impl BitOrAssign for PxPairFlags
impl BitOrAssign for PxPairFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for PxPairFlags
impl BitXor for PxPairFlags
source§impl BitXorAssign for PxPairFlags
impl BitXorAssign for PxPairFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for PxPairFlags
impl Clone for PxPairFlags
source§fn clone(&self) -> PxPairFlags
fn clone(&self) -> PxPairFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PxPairFlags
impl Debug for PxPairFlags
source§impl Default for PxPairFlags
impl Default for PxPairFlags
source§fn default() -> PxPairFlags
fn default() -> PxPairFlags
source§impl Extend<PxPairFlags> for PxPairFlags
impl Extend<PxPairFlags> for PxPairFlags
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 FromIterator<PxPairFlags> for PxPairFlags
impl FromIterator<PxPairFlags> for PxPairFlags
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 PxPairFlags
impl Hash for PxPairFlags
source§impl LowerHex for PxPairFlags
impl LowerHex for PxPairFlags
source§impl Not for PxPairFlags
impl Not for PxPairFlags
source§impl Octal for PxPairFlags
impl Octal for PxPairFlags
source§impl Ord for PxPairFlags
impl Ord for PxPairFlags
source§fn cmp(&self, other: &PxPairFlags) -> Ordering
fn cmp(&self, other: &PxPairFlags) -> 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 PxPairFlags
impl PartialEq for PxPairFlags
source§fn eq(&self, other: &PxPairFlags) -> bool
fn eq(&self, other: &PxPairFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for PxPairFlags
impl PartialOrd for PxPairFlags
source§fn partial_cmp(&self, other: &PxPairFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &PxPairFlags) -> 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 Sub for PxPairFlags
impl Sub for PxPairFlags
source§impl SubAssign for PxPairFlags
impl SubAssign for PxPairFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.