pub struct RayMap { /* private fields */ }
Expand description
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_events: EventWriter<PointerHits>,) {
for (&ray_id, &ray) in ray_map.iter() {
// Run a raycast with each ray, returning any `PointerHits` found.
}
}
Implementations§
Source§impl RayMap
impl RayMap
Sourcepub fn iter(&self) -> Iter<'_, RayId, Ray3d> ⓘ
pub fn iter(&self) -> Iter<'_, RayId, Ray3d> ⓘ
Iterates over all world space rays for every picking pointer.
Sourcepub fn map(&self) -> &HashMap<RayId, Ray3d>
pub fn map(&self) -> &HashMap<RayId, Ray3d>
The hash map of all rays cast in the current frame.
Sourcepub fn repopulate(
ray_map: ResMut<'_, RayMap>,
primary_window_entity: Query<'_, '_, Entity, With<PrimaryWindow>>,
cameras: Query<'_, '_, (Entity, &Camera, &GlobalTransform)>,
pointers: Query<'_, '_, (&PointerId, &PointerLocation)>,
)
pub fn repopulate( ray_map: ResMut<'_, RayMap>, primary_window_entity: Query<'_, '_, Entity, With<PrimaryWindow>>, cameras: Query<'_, '_, (Entity, &Camera, &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 Resource for RayMap
Auto Trait Implementations§
impl Freeze for RayMap
impl RefUnwindSafe for RayMap
impl Send for RayMap
impl Sync for RayMap
impl Unpin for RayMap
impl UnwindSafe for RayMap
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
Source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using default()
.
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more