Struct de_index::SpatialQuery

pub struct SpatialQuery<'w, 's, Q, F = ()>
where
    Q: QueryData + Sync + Send + 'static,
    F: QueryFilter + Sync + Send + 'static,
{
    index: Res<'w, EntityIndex>,
    entities: Query<'w, 's, Q, F>,
}

System parameter implementing various spatial queries.

Only entities automatically indexed by systems from super::PreciseIndexPlugin could be retrieved.

Fields

index: Res<'w, EntityIndex>

entities: Query<'w, 's, Q, F>

Implementations

impl<'w, 's, Q, F> SpatialQuery<'w, 's, Q, F>

where Q: QueryData + Sync + Send + 'static, F: QueryFilter + Sync + Send + 'static,

pub fn cast_ray( &self, ray: &Ray, max_toi: f32, ignore: Option<Entity> ) -> Option<RayEntityIntersection<ROQueryItem<'_, Q>>>

Returns closest entity whose shape, as indexed by systems registered by super::PreciseIndexPlugin, intersects a given ray.

Arguments

• ray - this method returns closest entity which is intersected by this ray up to a distance.

• max_toi - maximum entity distance given as a multiple of ray direction.

• ignore - if not None, this entity is not included in the possible intersections.

pub fn collides(&self, collider: &impl ColliderWithCache) -> bool

Returns true if queried solid object on the map, as indexed by super::PreciseIndexPlugin, intersects with the given collider.

pub fn query_aabb<'a, 'b>( &'a self, aabb: &'b Aabb, ignore: Option<Entity> ) -> AabbQueryResults<'w, 's, 'a, 'b, Q, F>

Trait Implementations

impl<Q, F> SystemParam for SpatialQuery<'_, '_, Q, F>

where Q: QueryData + Sync + Send + 'static, F: QueryFilter + Sync + Send + 'static,

type State = FetchState<Q, F>

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

type Item<'w, 's> = SpatialQuery<'w, 's, Q, F>

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.

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).

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.

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, Q, F> ReadOnlySystemParam for SpatialQuery<'w, 's, Q, F>

where Q: QueryData + Sync + Send + 'static, F: QueryFilter + Sync + Send + 'static, Res<'w, EntityIndex>: ReadOnlySystemParam, Query<'w, 's, Q, F>: ReadOnlySystemParam,