Struct jumpy::core::physics::rapier::QueryFilterFlags

pub struct QueryFilterFlags {
    bits: u32,
}

Flags for excluding whole sets of colliders from a scene query.

Fields

bits: u32

Implementations

impl QueryFilterFlags

pub const EXCLUDE_FIXED: QueryFilterFlags = _

Exclude from the query any collider attached to a fixed rigid-body and colliders with no rigid-body attached.

pub const EXCLUDE_KINEMATIC: QueryFilterFlags = _

Exclude from the query any collider attached to a kinematic rigid-body.

pub const EXCLUDE_DYNAMIC: QueryFilterFlags = _

Exclude from the query any collider attached to a dynamic rigid-body.

pub const EXCLUDE_SENSORS: QueryFilterFlags = _

Exclude from the query any collider that is a sensor.

pub const EXCLUDE_SOLIDS: QueryFilterFlags = _

Exclude from the query any collider that is not a sensor.

pub const ONLY_DYNAMIC: QueryFilterFlags = _

Excludes all colliders not attached to a dynamic rigid-body.

pub const ONLY_KINEMATIC: QueryFilterFlags = _

Excludes all colliders not attached to a kinematic rigid-body.

pub const ONLY_FIXED: QueryFilterFlags = _

Exclude all colliders attached to a non-fixed rigid-body (this will not exclude colliders not attached to any rigid-body).

pub const fn empty() -> QueryFilterFlags

Returns an empty set of flags.

pub const fn all() -> QueryFilterFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<QueryFilterFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> QueryFilterFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> QueryFilterFlags

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: QueryFilterFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: QueryFilterFlags) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: QueryFilterFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: QueryFilterFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: QueryFilterFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: QueryFilterFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: QueryFilterFlags) -> QueryFilterFlags

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.

pub const fn union(self, other: QueryFilterFlags) -> QueryFilterFlags

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.

pub const fn difference(self, other: QueryFilterFlags) -> QueryFilterFlags

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.

pub const fn symmetric_difference( self, other: QueryFilterFlags, ) -> QueryFilterFlags

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.

pub const fn complement(self) -> QueryFilterFlags

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.

impl QueryFilterFlags

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

impl Binary for QueryFilterFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl BitAnd for QueryFilterFlags

fn bitand(self, other: QueryFilterFlags) -> QueryFilterFlags

Returns the intersection between the two sets of flags.

type Output = QueryFilterFlags

The resulting type after applying the & operator.

impl BitAndAssign for QueryFilterFlags

fn bitand_assign(&mut self, other: QueryFilterFlags)

Disables all flags disabled in the set.

impl BitOr for QueryFilterFlags

fn bitor(self, other: QueryFilterFlags) -> QueryFilterFlags

Returns the union of the two sets of flags.

type Output = QueryFilterFlags

The resulting type after applying the | operator.

impl BitOrAssign for QueryFilterFlags

fn bitor_assign(&mut self, other: QueryFilterFlags)

Adds the set of flags.

impl BitXor for QueryFilterFlags

fn bitxor(self, other: QueryFilterFlags) -> QueryFilterFlags

Returns the left flags, but with all the right flags toggled.

type Output = QueryFilterFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for QueryFilterFlags

fn bitxor_assign(&mut self, other: QueryFilterFlags)

Toggles the set of flags.

impl Clone for QueryFilterFlags

fn clone(&self) -> QueryFilterFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryFilterFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for QueryFilterFlags

fn default() -> QueryFilterFlags

Returns the “default value” for a type.

impl Extend<QueryFilterFlags> for QueryFilterFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = QueryFilterFlags>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> From<QueryFilterFlags> for QueryFilter<'a>

fn from(flags: QueryFilterFlags) -> QueryFilter<'a>

Converts to this type from the input type.

impl FromIterator<QueryFilterFlags> for QueryFilterFlags

fn from_iter<T>(iterator: T) -> QueryFilterFlags

where T: IntoIterator<Item = QueryFilterFlags>,

Creates a value from an iterator.

impl Hash for QueryFilterFlags

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for QueryFilterFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Not for QueryFilterFlags

fn not(self) -> QueryFilterFlags

Returns the complement of this set of flags.

type Output = QueryFilterFlags

The resulting type after applying the ! operator.

impl Octal for QueryFilterFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Ord for QueryFilterFlags

fn cmp(&self, other: &QueryFilterFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for QueryFilterFlags

fn eq(&self, other: &QueryFilterFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for QueryFilterFlags

fn partial_cmp(&self, other: &QueryFilterFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for QueryFilterFlags

fn sub(self, other: QueryFilterFlags) -> QueryFilterFlags

Returns the set difference of the two sets of flags.

type Output = QueryFilterFlags

The resulting type after applying the - operator.

impl SubAssign for QueryFilterFlags

fn sub_assign(&mut self, other: QueryFilterFlags)

Disables all flags enabled in the set.

impl UpperHex for QueryFilterFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Copy for QueryFilterFlags

impl Eq for QueryFilterFlags

impl StructuralPartialEq for QueryFilterFlags