Struct Raycast

pub struct Raycast<'w, 's> { /* private fields */ }

Add this raycasting SystemParam to your system to raycast into the world with an immediate-mode API. Call cast_ray to immediately perform a raycast and get a result. Under the hood, this is a collection of regular bevy queries, resources, and locals that are added to your system.

Usage

The following system raycasts into the world with a ray positioned at the origin, pointing in the x-direction, and returns a list of intersections:

fn raycast_system(mut raycast: Raycast) {
    let ray = Ray3d::new(Vec3::ZERO, Vec3::X);
    let hits = raycast.cast_ray(ray, &RaycastSettings::default());
}

Configuration

You can specify behavior of the raycast using RaycastSettings. This allows you to filter out entities, configure early-out, and set whether the Visibility of an entity should be considered.

fn raycast_system(mut raycast: Raycast, foo_query: Query<(), With<Foo>>) {
    let ray = Ray3d::new(Vec3::ZERO, Vec3::X);

    // Only raycast against entities with the `Foo` component.
    let filter = |entity| foo_query.contains(entity);
    // Never early-exit. Note that you can change behavior per-entity.
    let early_exit_test = |_entity| false;
    // Ignore the visibility of entities. This allows raycasting hidden entities.
    let visibility = RaycastVisibility::Ignore;

    let settings = RaycastSettings::default()
        .with_filter(&filter)
        .with_early_exit_test(&early_exit_test)
        .with_visibility(visibility);

    let hits = raycast.cast_ray(ray, &settings);
}

Implementations

impl<'w, 's> Raycast<'w, 's>

pub fn debug_cast_ray( &mut self, ray: Ray3d, settings: &RaycastSettings<'_>, gizmos: &mut Gizmos<'_, '_>, ) -> &[(Entity, IntersectionData)]

Like Raycast::cast_ray, but debug-draws the ray and intersection.

pub fn cast_ray( &mut self, ray: Ray3d, settings: &RaycastSettings<'_>, ) -> &[(Entity, IntersectionData)]

Casts the ray into the world and returns a sorted list of intersections, nearest first.

Trait Implementations

impl SystemParam for Raycast<'_, '_>

type State = FetchState

Used to store data which persists across invocations of a system.

type Item<'w, 's> = Raycast<'w, 's>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next apply_deferred.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's> ReadOnlySystemParam for Raycast<'w, 's>

where Res<'w, Assets<Mesh>>: ReadOnlySystemParam, Local<'s, Vec<(FloatOrd, (Entity, IntersectionData))>>: ReadOnlySystemParam, Local<'s, Vec<(Entity, IntersectionData)>>: ReadOnlySystemParam, Local<'s, Vec<(FloatOrd, Entity)>>: ReadOnlySystemParam, Query<'w, 's, (Read<InheritedVisibility>, Read<ViewVisibility>, Read<Aabb>, Read<GlobalTransform>, Entity), Or<(With<Handle<Mesh>>, With<Mesh2dHandle>)>>: ReadOnlySystemParam, Query<'w, 's, (Read<Handle<Mesh>>, Option<Read<SimplifiedMesh>>, Option<Read<NoBackfaceCulling>>, Read<GlobalTransform>)>: ReadOnlySystemParam, Query<'w, 's, (Read<Mesh2dHandle>, Option<Read<SimplifiedMesh>>, Read<GlobalTransform>)>: ReadOnlySystemParam,