Struct rapier2d::pipeline::QueryFilterFlags
source · pub struct QueryFilterFlags { /* private fields */ }
Expand description
Flags for excluding whole sets of colliders from a scene query.
Implementations§
source§impl QueryFilterFlags
impl QueryFilterFlags
sourcepub const EXCLUDE_FIXED: Self = _
pub const EXCLUDE_FIXED: Self = _
Exclude from the query any collider attached to a fixed rigid-body and colliders with no rigid-body attached.
sourcepub const EXCLUDE_KINEMATIC: Self = _
pub const EXCLUDE_KINEMATIC: Self = _
Exclude from the query any collider attached to a kinematic rigid-body.
sourcepub const EXCLUDE_DYNAMIC: Self = _
pub const EXCLUDE_DYNAMIC: Self = _
Exclude from the query any collider attached to a dynamic rigid-body.
sourcepub const EXCLUDE_SENSORS: Self = _
pub const EXCLUDE_SENSORS: Self = _
Exclude from the query any collider that is a sensor.
sourcepub const EXCLUDE_SOLIDS: Self = _
pub const EXCLUDE_SOLIDS: Self = _
Exclude from the query any collider that is not a sensor.
sourcepub const ONLY_DYNAMIC: Self = _
pub const ONLY_DYNAMIC: Self = _
Excludes all colliders not attached to a dynamic rigid-body.
sourcepub const ONLY_KINEMATIC: Self = _
pub const ONLY_KINEMATIC: Self = _
Excludes all colliders not attached to a kinematic rigid-body.
sourcepub const ONLY_FIXED: Self = _
pub const ONLY_FIXED: Self = _
Exclude all colliders attached to a non-fixed rigid-body (this will not exclude colliders not attached to any rigid-body).
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
.
source§impl QueryFilterFlags
impl QueryFilterFlags
sourcepub fn test(&self, bodies: &RigidBodySet, collider: &Collider) -> bool
pub fn test(&self, bodies: &RigidBodySet, collider: &Collider) -> bool
Tests if the given collider should be taken into account by a scene query, based
on the flags on self
.
Trait Implementations§
source§impl Binary for QueryFilterFlags
impl Binary for QueryFilterFlags
source§impl BitAnd for QueryFilterFlags
impl BitAnd for QueryFilterFlags
source§impl BitAndAssign for QueryFilterFlags
impl BitAndAssign for QueryFilterFlags
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 QueryFilterFlags
impl BitOr for QueryFilterFlags
source§fn bitor(self, other: QueryFilterFlags) -> Self
fn bitor(self, other: QueryFilterFlags) -> Self
Returns the union of the two sets of flags.
§type Output = QueryFilterFlags
type Output = QueryFilterFlags
|
operator.source§impl BitOrAssign for QueryFilterFlags
impl BitOrAssign for QueryFilterFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for QueryFilterFlags
impl BitXor for QueryFilterFlags
source§impl BitXorAssign for QueryFilterFlags
impl BitXorAssign for QueryFilterFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for QueryFilterFlags
impl Clone for QueryFilterFlags
source§fn clone(&self) -> QueryFilterFlags
fn clone(&self) -> QueryFilterFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for QueryFilterFlags
impl Debug for QueryFilterFlags
source§impl Default for QueryFilterFlags
impl Default for QueryFilterFlags
source§fn default() -> QueryFilterFlags
fn default() -> QueryFilterFlags
source§impl Extend<QueryFilterFlags> for QueryFilterFlags
impl Extend<QueryFilterFlags> for QueryFilterFlags
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<'a> From<QueryFilterFlags> for QueryFilter<'a>
impl<'a> From<QueryFilterFlags> for QueryFilter<'a>
source§fn from(flags: QueryFilterFlags) -> Self
fn from(flags: QueryFilterFlags) -> Self
source§impl FromIterator<QueryFilterFlags> for QueryFilterFlags
impl FromIterator<QueryFilterFlags> for QueryFilterFlags
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 QueryFilterFlags
impl Hash for QueryFilterFlags
source§impl LowerHex for QueryFilterFlags
impl LowerHex for QueryFilterFlags
source§impl Not for QueryFilterFlags
impl Not for QueryFilterFlags
source§impl Octal for QueryFilterFlags
impl Octal for QueryFilterFlags
source§impl Ord for QueryFilterFlags
impl Ord for QueryFilterFlags
source§fn cmp(&self, other: &QueryFilterFlags) -> Ordering
fn cmp(&self, other: &QueryFilterFlags) -> 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 QueryFilterFlags
impl PartialEq for QueryFilterFlags
source§fn eq(&self, other: &QueryFilterFlags) -> bool
fn eq(&self, other: &QueryFilterFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for QueryFilterFlags
impl PartialOrd for QueryFilterFlags
source§fn partial_cmp(&self, other: &QueryFilterFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &QueryFilterFlags) -> 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 QueryFilterFlags
impl Sub for QueryFilterFlags
source§impl SubAssign for QueryFilterFlags
impl SubAssign for QueryFilterFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for QueryFilterFlags
impl UpperHex for QueryFilterFlags
impl Copy for QueryFilterFlags
impl Eq for QueryFilterFlags
impl StructuralPartialEq for QueryFilterFlags
Auto Trait Implementations§
impl Freeze for QueryFilterFlags
impl RefUnwindSafe for QueryFilterFlags
impl Send for QueryFilterFlags
impl Sync for QueryFilterFlags
impl Unpin for QueryFilterFlags
impl UnwindSafe for QueryFilterFlags
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.