Struct physx::physics::AggregateFilterHint
source · #[repr(transparent)]pub struct AggregateFilterHint { /* private fields */ }
Expand description
Used for more efficient filtering of aggregates outside of the broadphase
If neither the AggregateFilterHint::STATIC
or
AggregateFilterHint::KINEMATIC
bits are set the hint applies to all
actor types. It is recommended to set either of them if the aggregate
only contains static or kinematic actors as this provides faster
filtering when used in combination with physx_sys::PxPairFilteringMode
Implementations§
source§impl AggregateFilterHint
impl AggregateFilterHint
sourcepub const SELF_COLLISION: Self = _
pub const SELF_COLLISION: Self = _
If set enables self collision for the aggregate
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 AggregateFilterHint
impl Binary for AggregateFilterHint
source§impl BitAndAssign<AggregateFilterHint> for AggregateFilterHint
impl BitAndAssign<AggregateFilterHint> for AggregateFilterHint
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<AggregateFilterHint> for AggregateFilterHint
impl BitOr<AggregateFilterHint> for AggregateFilterHint
source§fn bitor(self, other: AggregateFilterHint) -> Self
fn bitor(self, other: AggregateFilterHint) -> Self
Returns the union of the two sets of flags.
§type Output = AggregateFilterHint
type Output = AggregateFilterHint
|
operator.source§impl BitOrAssign<AggregateFilterHint> for AggregateFilterHint
impl BitOrAssign<AggregateFilterHint> for AggregateFilterHint
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<AggregateFilterHint> for AggregateFilterHint
impl BitXorAssign<AggregateFilterHint> for AggregateFilterHint
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for AggregateFilterHint
impl Clone for AggregateFilterHint
source§fn clone(&self) -> AggregateFilterHint
fn clone(&self) -> AggregateFilterHint
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AggregateFilterHint
impl Debug for AggregateFilterHint
source§impl Extend<AggregateFilterHint> for AggregateFilterHint
impl Extend<AggregateFilterHint> for AggregateFilterHint
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<AggregateFilterHint> for AggregateFilterHint
impl FromIterator<AggregateFilterHint> for AggregateFilterHint
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 AggregateFilterHint
impl Hash for AggregateFilterHint
source§impl LowerHex for AggregateFilterHint
impl LowerHex for AggregateFilterHint
source§impl Not for AggregateFilterHint
impl Not for AggregateFilterHint
source§impl Octal for AggregateFilterHint
impl Octal for AggregateFilterHint
source§impl Ord for AggregateFilterHint
impl Ord for AggregateFilterHint
source§fn cmp(&self, other: &AggregateFilterHint) -> Ordering
fn cmp(&self, other: &AggregateFilterHint) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<AggregateFilterHint> for AggregateFilterHint
impl PartialEq<AggregateFilterHint> for AggregateFilterHint
source§fn eq(&self, other: &AggregateFilterHint) -> bool
fn eq(&self, other: &AggregateFilterHint) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<AggregateFilterHint> for AggregateFilterHint
impl PartialOrd<AggregateFilterHint> for AggregateFilterHint
source§fn partial_cmp(&self, other: &AggregateFilterHint) -> Option<Ordering>
fn partial_cmp(&self, other: &AggregateFilterHint) -> 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<AggregateFilterHint> for AggregateFilterHint
impl Sub<AggregateFilterHint> for AggregateFilterHint
source§impl SubAssign<AggregateFilterHint> for AggregateFilterHint
impl SubAssign<AggregateFilterHint> for AggregateFilterHint
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.