Struct physx::prelude::ShapeFlags
source · pub struct ShapeFlags { /* private fields */ }
Expand description
Flags for PxShapeFlag
Implementations§
source§impl PxShapeFlags
impl PxShapeFlags
pub const SimulationShape: PxShapeFlags = Self{ bits: 1 << 0,}
pub const SceneQueryShape: PxShapeFlags = Self{ bits: 1 << 1,}
pub const TriggerShape: PxShapeFlags = Self{ bits: 1 << 2,}
pub const Visualization: PxShapeFlags = Self{ bits: 1 << 3,}
sourcepub const fn empty() -> PxShapeFlags
pub const fn empty() -> PxShapeFlags
Returns an empty set of flags.
sourcepub const fn all() -> PxShapeFlags
pub const fn all() -> PxShapeFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<PxShapeFlags>
pub const fn from_bits(bits: u8) -> Option<PxShapeFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> PxShapeFlags
pub const fn from_bits_truncate(bits: u8) -> PxShapeFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> PxShapeFlags
pub const unsafe fn from_bits_unchecked(bits: u8) -> PxShapeFlags
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: PxShapeFlags) -> bool
pub const fn intersects(&self, other: PxShapeFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: PxShapeFlags) -> bool
pub const fn contains(&self, other: PxShapeFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: PxShapeFlags)
pub fn insert(&mut self, other: PxShapeFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: PxShapeFlags)
pub fn remove(&mut self, other: PxShapeFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: PxShapeFlags)
pub fn toggle(&mut self, other: PxShapeFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: PxShapeFlags, value: bool)
pub fn set(&mut self, other: PxShapeFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: PxShapeFlags) -> PxShapeFlags
pub const fn intersection(self, other: PxShapeFlags) -> PxShapeFlags
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: PxShapeFlags) -> PxShapeFlags
pub const fn union(self, other: PxShapeFlags) -> PxShapeFlags
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: PxShapeFlags) -> PxShapeFlags
pub const fn difference(self, other: PxShapeFlags) -> PxShapeFlags
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: PxShapeFlags) -> PxShapeFlags
pub const fn symmetric_difference(self, other: PxShapeFlags) -> PxShapeFlags
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) -> PxShapeFlags
pub const fn complement(self) -> PxShapeFlags
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 PxShapeFlags
impl Binary for PxShapeFlags
source§impl BitAnd<PxShapeFlags> for PxShapeFlags
impl BitAnd<PxShapeFlags> for PxShapeFlags
source§fn bitand(self, other: PxShapeFlags) -> PxShapeFlags
fn bitand(self, other: PxShapeFlags) -> PxShapeFlags
Returns the intersection between the two sets of flags.
§type Output = PxShapeFlags
type Output = PxShapeFlags
&
operator.source§impl BitAndAssign<PxShapeFlags> for PxShapeFlags
impl BitAndAssign<PxShapeFlags> for PxShapeFlags
source§fn bitand_assign(&mut self, other: PxShapeFlags)
fn bitand_assign(&mut self, other: PxShapeFlags)
Disables all flags disabled in the set.
source§impl BitOr<PxShapeFlags> for PxShapeFlags
impl BitOr<PxShapeFlags> for PxShapeFlags
source§fn bitor(self, other: PxShapeFlags) -> PxShapeFlags
fn bitor(self, other: PxShapeFlags) -> PxShapeFlags
Returns the union of the two sets of flags.
§type Output = PxShapeFlags
type Output = PxShapeFlags
|
operator.source§impl BitOrAssign<PxShapeFlags> for PxShapeFlags
impl BitOrAssign<PxShapeFlags> for PxShapeFlags
source§fn bitor_assign(&mut self, other: PxShapeFlags)
fn bitor_assign(&mut self, other: PxShapeFlags)
Adds the set of flags.
source§impl BitXor<PxShapeFlags> for PxShapeFlags
impl BitXor<PxShapeFlags> for PxShapeFlags
source§fn bitxor(self, other: PxShapeFlags) -> PxShapeFlags
fn bitxor(self, other: PxShapeFlags) -> PxShapeFlags
Returns the left flags, but with all the right flags toggled.
§type Output = PxShapeFlags
type Output = PxShapeFlags
^
operator.source§impl BitXorAssign<PxShapeFlags> for PxShapeFlags
impl BitXorAssign<PxShapeFlags> for PxShapeFlags
source§fn bitxor_assign(&mut self, other: PxShapeFlags)
fn bitxor_assign(&mut self, other: PxShapeFlags)
Toggles the set of flags.
source§impl Clone for PxShapeFlags
impl Clone for PxShapeFlags
source§fn clone(&self) -> PxShapeFlags
fn clone(&self) -> PxShapeFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PxShapeFlags
impl Debug for PxShapeFlags
source§impl Default for PxShapeFlags
impl Default for PxShapeFlags
source§fn default() -> PxShapeFlags
fn default() -> PxShapeFlags
source§impl Extend<PxShapeFlags> for PxShapeFlags
impl Extend<PxShapeFlags> for PxShapeFlags
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = PxShapeFlags>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = PxShapeFlags>,
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<PxShapeFlags> for PxShapeFlags
impl FromIterator<PxShapeFlags> for PxShapeFlags
source§fn from_iter<T>(iterator: T) -> PxShapeFlagswhere
T: IntoIterator<Item = PxShapeFlags>,
fn from_iter<T>(iterator: T) -> PxShapeFlagswhere T: IntoIterator<Item = PxShapeFlags>,
source§impl Hash for PxShapeFlags
impl Hash for PxShapeFlags
source§impl LowerHex for PxShapeFlags
impl LowerHex for PxShapeFlags
source§impl Not for PxShapeFlags
impl Not for PxShapeFlags
source§fn not(self) -> PxShapeFlags
fn not(self) -> PxShapeFlags
Returns the complement of this set of flags.
§type Output = PxShapeFlags
type Output = PxShapeFlags
!
operator.source§impl Octal for PxShapeFlags
impl Octal for PxShapeFlags
source§impl Ord for PxShapeFlags
impl Ord for PxShapeFlags
source§fn cmp(&self, other: &PxShapeFlags) -> Ordering
fn cmp(&self, other: &PxShapeFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<PxShapeFlags> for PxShapeFlags
impl PartialEq<PxShapeFlags> for PxShapeFlags
source§fn eq(&self, other: &PxShapeFlags) -> bool
fn eq(&self, other: &PxShapeFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<PxShapeFlags> for PxShapeFlags
impl PartialOrd<PxShapeFlags> for PxShapeFlags
source§fn partial_cmp(&self, other: &PxShapeFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &PxShapeFlags) -> 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<PxShapeFlags> for PxShapeFlags
impl Sub<PxShapeFlags> for PxShapeFlags
source§fn sub(self, other: PxShapeFlags) -> PxShapeFlags
fn sub(self, other: PxShapeFlags) -> PxShapeFlags
Returns the set difference of the two sets of flags.
§type Output = PxShapeFlags
type Output = PxShapeFlags
-
operator.source§impl SubAssign<PxShapeFlags> for PxShapeFlags
impl SubAssign<PxShapeFlags> for PxShapeFlags
source§fn sub_assign(&mut self, other: PxShapeFlags)
fn sub_assign(&mut self, other: PxShapeFlags)
Disables all flags enabled in the set.