Struct RayFilter 

#[non_exhaustive]
pub struct RayFilter {
    pub layer_mask: u32,
    pub exclude_body: Option<usize>,
    pub include_sensors: bool,
    pub include_static: bool,
    pub include_sdf: bool,
    pub sdf: SdfCcdConfig,
}

Which colliders a ray query sees.

The default sees every body on any layer except sensors, every static collider and every SDF collider. A body is seen when layer_mask & body_filter.layer != 0 (PhysicsWorld::body_filter); an SDF collider attached to a body is seen only when that body is.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

layer_mask: u32

Layers the ray sees (bitmask against CollisionFilter::layer).

exclude_body: Option<usize>

A body the ray ignores (typically the one carrying the sensor).

include_sensors: bool

Whether sensor bodies are seen.

include_static: bool

Whether static colliders are seen.

include_sdf: bool

Whether SDF colliders are seen.

sdf: SdfCcdConfig

Sphere-tracing settings for SDF colliders.

Implementations

impl RayFilter

pub fn new() -> Self

The default filter (see the type doc).

pub const fn with_layer_mask(self, mask: u32) -> Self

Only bodies on these layers.

pub const fn excluding_body(self, body: usize) -> Self

Ignore this body (and any SDF collider attached to it).

pub const fn with_sensors(self, include: bool) -> Self

Whether sensor bodies are seen.

pub const fn with_static(self, include: bool) -> Self

Whether static colliders are seen.

pub const fn with_sdf(self, include: bool) -> Self

Whether SDF colliders are seen.

pub const fn with_sdf_config(self, config: SdfCcdConfig) -> Self

Sphere-tracing settings for SDF colliders.

Trait Implementations

impl Clone for RayFilter

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RayFilter

impl Debug for RayFilter

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

Formats the value using the given formatter.

impl Default for RayFilter

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RayFilter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RayFilter