Struct bevy_mod_raycast::immediate::RaycastSettings

pub struct RaycastSettings<'a> {
    pub visibility: RaycastVisibility,
    pub filter: &'a dyn Fn(Entity) -> bool,
    pub early_exit_test: &'a dyn Fn(Entity) -> bool,
}

Settings for a raycast.

Fields

visibility: RaycastVisibility

Determines how raycasting should consider entity visibility.

filter: &'a dyn Fn(Entity) -> bool

A filtering function that is applied to every entity that is raycasted. Only entities that return true will be considered.

early_exit_test: &'a dyn Fn(Entity) -> bool

A function that is run every time a hit is found. Raycasting will continue to check for hits along the ray as long as this returns false.

Implementations

impl<'a> RaycastSettings<'a>

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

Set the filter to apply to the raycast.

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

Set the early exit test to apply to the raycast.

pub fn with_visibility(self, visibility: RaycastVisibility) -> Self

Set the RaycastVisibility setting to apply to the raycast.

pub fn always_early_exit(self) -> Self

This raycast should exit as soon as the nearest hit is found.

pub fn never_early_exit(self) -> Self

This raycast should check all entities whose AABB intersects the ray and return all hits.

Trait Implementations

impl<'a> Clone for RaycastSettings<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for RaycastSettings<'a>

fn default() -> Self

Returns the “default value” for a type.