Struct SpatialQueryFilter

pub struct SpatialQueryFilter {
    pub mask: LayerMask,
    pub excluded_entities: EntityHashSet,
}

Rules that determine which colliders are taken into account in spatial queries.

Example

use avian3d::prelude::*;
use bevy::prelude::*;

fn setup(mut commands: Commands) {
    let object = commands.spawn(Collider::sphere(0.5)).id();

    // A query filter that has three collision layers and excludes the `object` entity
    let query_filter = SpatialQueryFilter::from_mask(0b1011).with_excluded_entities([object]);

    // Spawn a ray caster with the query filter
    commands.spawn(RayCaster::default().with_query_filter(query_filter));
}

Fields

mask: LayerMask

Specifies which collision layers will be included in the spatial query.

excluded_entities: EntityHashSet

Entities that will not be included in spatial queries.

Implementations

impl SpatialQueryFilter

pub const DEFAULT: Self = _

The default SpatialQueryFilter configuration that includes all collision layers and has no excluded entities.

pub fn from_mask(mask: impl Into<LayerMask>) -> Self

Creates a new SpatialQueryFilter with the given LayerMask determining which collision layers will be included in the spatial query.

pub fn from_excluded_entities( entities: impl IntoIterator<Item = Entity>, ) -> Self

Creates a new SpatialQueryFilter with the given entities excluded from the spatial query.

pub fn with_mask(self, masks: impl Into<LayerMask>) -> Self

Sets the LayerMask of the filter configuration. Only colliders with the corresponding collision layer memberships will be included in the spatial query.

pub fn with_excluded_entities( self, entities: impl IntoIterator<Item = Entity>, ) -> Self

Excludes the given entities from the spatial query.

pub fn test(&self, entity: Entity, layers: CollisionLayers) -> bool

Tests if an entity should be included in spatial queries based on the filter configuration.

Trait Implementations

impl Clone for SpatialQueryFilter

fn clone(&self) -> SpatialQueryFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpatialQueryFilter

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

Formats the value using the given formatter.

impl Default for SpatialQueryFilter

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for SpatialQueryFilter

where SpatialQueryFilter: Any + Send + Sync, LayerMask: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EntityHashSet: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for SpatialQueryFilter

where SpatialQueryFilter: Any + Send + Sync, LayerMask: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EntityHashSet: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for SpatialQueryFilter

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialReflect for SpatialQueryFilter

where SpatialQueryFilter: Any + Send + Sync, LayerMask: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EntityHashSet: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for SpatialQueryFilter

where SpatialQueryFilter: Any + Send + Sync, LayerMask: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EntityHashSet: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Struct for SpatialQueryFilter

where SpatialQueryFilter: Any + Send + Sync, LayerMask: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EntityHashSet: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for SpatialQueryFilter

where SpatialQueryFilter: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for SpatialQueryFilter

where SpatialQueryFilter: Any + Send + Sync, LayerMask: FromReflect + TypePath + MaybeTyped + RegisterForReflection, EntityHashSet: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl StructuralPartialEq for SpatialQueryFilter