Struct ark_api::world::SpatialQueryOptions

#[repr(C)]
pub struct SpatialQueryOptions { /* private fields */ }

Implementations

impl SpatialQueryOptions

pub const APPLY_ENTITY_POSITION: SpatialQueryOptions = Self{ bits: 1,}

👎Deprecated

pub const APPLY_ENTITY_ROTATION: SpatialQueryOptions = Self{ bits: 2,}

👎Deprecated

pub const APPLY_ENTITY_SCALE: SpatialQueryOptions = Self{ bits: 4,}

👎Deprecated

pub const APPLY_ENTITY_TRANSFORM: SpatialQueryOptions = Self{ bits: Self::APPLY_ENTITY_POSITION.bits() | Self::APPLY_ENTITY_ROTATION.bits() | Self::APPLY_ENTITY_SCALE.bits(),}

👎Deprecated

pub const FORCE_WORLD_SPACE_DIRECTION_OR_NORMAL: SpatialQueryOptions = Self{ bits: 8,}

👎Deprecated

pub const PHYSX_QUERY: SpatialQueryOptions = Self{ bits: 16,}

Faster, especially for raycasts, but only hits PhysX shapes, not exact meshes.

pub const IGNORE_INTERIOR_HITS: SpatialQueryOptions = Self{ bits: 32,}

For raycasts, ignores any shapes we start within (t = min_t).

pub const fn empty() -> SpatialQueryOptions

Returns an empty set of flags.

pub const fn all() -> SpatialQueryOptions

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u8) -> Option<SpatialQueryOptions>

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

pub const fn from_bits_truncate(bits: u8) -> SpatialQueryOptions

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

pub const unsafe fn from_bits_unchecked(bits: u8) -> SpatialQueryOptions

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: SpatialQueryOptions) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

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: SpatialQueryOptions) -> SpatialQueryOptions

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: SpatialQueryOptions) -> SpatialQueryOptions

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: SpatialQueryOptions
) -> SpatialQueryOptions

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) -> SpatialQueryOptions

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

impl Binary for SpatialQueryOptions

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

Formats the value using the given formatter.

impl BitAnd<SpatialQueryOptions> for SpatialQueryOptions

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

Returns the intersection between the two sets of flags.

type Output = SpatialQueryOptions

The resulting type after applying the & operator.

impl BitAndAssign<SpatialQueryOptions> for SpatialQueryOptions

fn bitand_assign(&mut self, other: SpatialQueryOptions)

Disables all flags disabled in the set.

impl BitOr<SpatialQueryOptions> for SpatialQueryOptions

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

Returns the union of the two sets of flags.

type Output = SpatialQueryOptions

The resulting type after applying the | operator.

impl BitOrAssign<SpatialQueryOptions> for SpatialQueryOptions

fn bitor_assign(&mut self, other: SpatialQueryOptions)

Adds the set of flags.

impl BitXor<SpatialQueryOptions> for SpatialQueryOptions

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

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

type Output = SpatialQueryOptions

The resulting type after applying the ^ operator.

impl BitXorAssign<SpatialQueryOptions> for SpatialQueryOptions

fn bitxor_assign(&mut self, other: SpatialQueryOptions)

Toggles the set of flags.

impl Clone for SpatialQueryOptions

fn clone(&self) -> SpatialQueryOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpatialQueryOptions

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

Formats the value using the given formatter.

impl Extend<SpatialQueryOptions> for SpatialQueryOptions

fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = SpatialQueryOptions>, 

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 FromIterator<SpatialQueryOptions> for SpatialQueryOptions

fn from_iter<T>(iterator: T) -> SpatialQueryOptions where
    T: IntoIterator<Item = SpatialQueryOptions>, 

Creates a value from an iterator.

impl Hash for SpatialQueryOptions

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, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for SpatialQueryOptions

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

Formats the value using the given formatter.

impl Not for SpatialQueryOptions

fn not(self) -> SpatialQueryOptions

Returns the complement of this set of flags.

type Output = SpatialQueryOptions

The resulting type after applying the ! operator.

impl Octal for SpatialQueryOptions

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

Formats the value using the given formatter.

impl Ord for SpatialQueryOptions

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<SpatialQueryOptions> for SpatialQueryOptions

fn eq(&self, other: &SpatialQueryOptions) -> 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<SpatialQueryOptions> for SpatialQueryOptions

fn partial_cmp(&self, other: &SpatialQueryOptions) -> 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<SpatialQueryOptions> for SpatialQueryOptions

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

Returns the set difference of the two sets of flags.

type Output = SpatialQueryOptions

The resulting type after applying the - operator.

impl SubAssign<SpatialQueryOptions> for SpatialQueryOptions

fn sub_assign(&mut self, other: SpatialQueryOptions)

Disables all flags enabled in the set.

impl UpperHex for SpatialQueryOptions

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

Formats the value using the given formatter.

impl Zeroable for SpatialQueryOptions

fn zeroed() -> Self

Calls zeroed.

impl Copy for SpatialQueryOptions

impl Eq for SpatialQueryOptions

impl Pod for SpatialQueryOptions

impl StructuralEq for SpatialQueryOptions

impl StructuralPartialEq for SpatialQueryOptions