Struct QueryFilter 

pub struct QueryFilter<'a> {
    pub flags: QueryFilterFlags,
    pub groups: Option<CollisionGroups>,
    pub exclude_collider: Option<Entity>,
    pub exclude_rigid_body: Option<Entity>,
    pub predicate: Option<&'a dyn Fn(Entity, &Collider) -> bool>,
}

A filter that describes what collider should be included or excluded from a scene query.

Fields

flags: QueryFilterFlags

Flags indicating what particular type of colliders should be excluded.

groups: Option<CollisionGroups>

If set, only colliders with collision groups compatible with this one will be included in the scene query.

The CollisionGroups::test_mode of both groups is taken into account.

exclude_collider: Option<Entity>

If set, the collider attached to that entity will be excluded from the query.

exclude_rigid_body: Option<Entity>

If set, any collider attached to the rigid-body attached to that entity will be excluded from the query.

predicate: Option<&'a dyn Fn(Entity, &Collider) -> bool>

If set, any collider for which this closure returns false will be excluded from the query.

The closure is given the collider’s entity and its Rapier collider, which gives access to its shape, position, parent, etc.

Implementations

impl<'a> QueryFilter<'a>

pub fn new() -> Self

A query filter that doesn’t exclude any collider.

pub fn exclude_fixed() -> Self

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

pub fn exclude_kinematic() -> Self

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

pub fn exclude_dynamic() -> Self

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

pub fn only_dynamic() -> Self

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

pub fn only_kinematic() -> Self

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

pub fn only_fixed() -> Self

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

pub fn exclude_sensors(self) -> Self

Exclude from the query any collider that is a sensor.

pub fn exclude_solids(self) -> Self

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

pub fn groups(self, groups: CollisionGroups) -> Self

Only colliders with collision groups compatible with this one will be included in the scene query.

The CollisionGroups::test_mode of both groups is taken into account.

pub fn exclude_collider(self, collider: Entity) -> Self

Set the collider that will be excluded from the scene query.

pub fn exclude_rigid_body(self, rigid_body: Entity) -> Self

Set the rigid-body that will be excluded from the scene query.

pub fn predicate( self, predicate: &'a impl Fn(Entity, &RapierCollider) -> bool, ) -> Self

Set the predicate to apply a custom collider filtering during the scene query.

The predicate is given the collider’s entity and its Rapier collider.

Trait Implementations

impl<'a> Clone for QueryFilter<'a>

fn clone(&self) -> QueryFilter<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for QueryFilter<'a>

impl<'a> Default for QueryFilter<'a>

fn default() -> QueryFilter<'a>

Returns the “default value” for a type.

impl From<CollisionGroups> for QueryFilter<'_>

fn from(groups: CollisionGroups) -> Self

Converts to this type from the input type.

impl From<QueryFilterFlags> for QueryFilter<'_>

fn from(flags: QueryFilterFlags) -> Self

Converts to this type from the input type.