Struct RayMap 

pub struct RayMap {
    pub map: HashMap<RayId, Ray3d>,
}

A map from RayId to Ray3d.

This map is cleared and re-populated every frame before any backends run. Ray-based picking backends should use this when possible, as it automatically handles viewports, DPI, and other details of building rays from pointer locations.

Usage

Iterate over each Ray3d and its RayId with RayMap::iter.

// My raycasting backend
pub fn update_hits(ray_map: Res<RayMap>, mut output_messages: MessageWriter<PointerHits>,) {
    for (&ray_id, &ray) in ray_map.iter() {
        // Run a raycast with each ray, returning any `PointerHits` found.
    }
}

Fields

map: HashMap<RayId, Ray3d>

Cartesian product of all pointers and all cameras Add your rays here to support picking through indirections, e.g. rendered-to-texture cameras

Implementations

impl RayMap

pub fn iter(&self) -> Iter<'_, RayId, Ray3d>

Iterates over all world space rays for every picking pointer.

pub fn repopulate( ray_map: ResMut<'_, Self>, primary_window_entity: Query<'_, '_, Entity, With<PrimaryWindow>>, cameras: Query<'_, '_, (Entity, &Camera, &RenderTarget, &GlobalTransform)>, pointers: Query<'_, '_, (&PointerId, &PointerLocation)>, )

Clears the RayMap and re-populates it with one ray for each combination of pointer entity and camera entity where the pointer intersects the camera’s viewport.

Trait Implementations

impl Clone for RayMap

fn clone(&self) -> RayMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for RayMap

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for RayMap

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

Formats the value using the given formatter.

impl Default for RayMap

fn default() -> RayMap

Returns the “default value” for a type.

impl Resource for RayMap

where Self: Send + Sync + 'static,