Struct bevy_mod_raycast::system_param::Raycast
source · pub struct Raycast<'w, 's, T: TypePath + Send + Sync> {
pub meshes: Res<'w, Assets<Mesh>>,
pub hits: Local<'s, Vec<(FloatOrd, (Entity, IntersectionData))>>,
pub output: Local<'s, Vec<(Entity, IntersectionData)>>,
pub culled_list: Local<'s, Vec<(FloatOrd, Entity)>>,
pub culling_query: Query<'w, 's, (Read<ComputedVisibility>, Read<Aabb>, Read<GlobalTransform>, Entity), With<RaycastMesh<T>>>,
pub mesh_query: Query<'w, 's, (Read<Handle<Mesh>>, Option<Read<SimplifiedMesh>>, Option<Read<NoBackfaceCulling>>, Read<GlobalTransform>), With<RaycastMesh<T>>>,
pub mesh2d_query: Query<'w, 's, (Read<Mesh2dHandle>, Option<Read<SimplifiedMesh>>, Read<GlobalTransform>), With<RaycastMesh<T>>>,
}
Expand description
A [SystemParam
] that allows you to raycast into the world.
Fields§
§meshes: Res<'w, Assets<Mesh>>
§hits: Local<'s, Vec<(FloatOrd, (Entity, IntersectionData))>>
§output: Local<'s, Vec<(Entity, IntersectionData)>>
§culled_list: Local<'s, Vec<(FloatOrd, Entity)>>
§culling_query: Query<'w, 's, (Read<ComputedVisibility>, Read<Aabb>, Read<GlobalTransform>, Entity), With<RaycastMesh<T>>>
§mesh_query: Query<'w, 's, (Read<Handle<Mesh>>, Option<Read<SimplifiedMesh>>, Option<Read<NoBackfaceCulling>>, Read<GlobalTransform>), With<RaycastMesh<T>>>
§mesh2d_query: Query<'w, 's, (Read<Mesh2dHandle>, Option<Read<SimplifiedMesh>>, Read<GlobalTransform>), With<RaycastMesh<T>>>
Implementations§
source§impl<'w, 's, T: TypePath + Send + Sync> Raycast<'w, 's, T>
impl<'w, 's, T: TypePath + Send + Sync> Raycast<'w, 's, T>
sourcepub fn cast_ray(
&mut self,
ray: Ray3d,
settings: &RaycastSettings
) -> &[(Entity, IntersectionData)]
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.
Setting should_frustum_cull
to true will prevent raycasting anything that is not visible
to a camera. This is a useful optimization when doing a screenspace raycast.
Trait Implementations§
source§impl<T: TypePath + Send + Sync> SystemParam for Raycast<'_, '_, T>
impl<T: TypePath + Send + Sync> SystemParam for Raycast<'_, '_, T>
§type Item<'w, 's> = Raycast<'w, 's, T>
type Item<'w, 's> = Raycast<'w, 's, T>
The item type returned when constructing this system param.
The value of this associated type should be
Self
, instantiated with new lifetimes. Read moresource§fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
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
.source§fn new_archetype(
state: &mut Self::State,
archetype: &Archetype,
system_meta: &mut SystemMeta
)
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).source§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
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
.source§unsafe fn get_param<'w, 's>(
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick
) -> Self::Item<'w, 's>
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
. Read moreimpl<'w, 's, T: TypePath + Send + Sync> ReadOnlySystemParam for Raycast<'w, 's, T>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<ComputedVisibility>, Read<Aabb>, Read<GlobalTransform>, Entity), With<RaycastMesh<T>>>: ReadOnlySystemParam, Query<'w, 's, (Read<Handle<Mesh>>, Option<Read<SimplifiedMesh>>, Option<Read<NoBackfaceCulling>>, Read<GlobalTransform>), With<RaycastMesh<T>>>: ReadOnlySystemParam, Query<'w, 's, (Read<Mesh2dHandle>, Option<Read<SimplifiedMesh>>, Read<GlobalTransform>), With<RaycastMesh<T>>>: ReadOnlySystemParam,
Auto Trait Implementations§
impl<'w, 's, T> !RefUnwindSafe for Raycast<'w, 's, T>
impl<'w, 's, T> Send for Raycast<'w, 's, T>
impl<'w, 's, T> Sync for Raycast<'w, 's, T>
impl<'w, 's, T> Unpin for Raycast<'w, 's, T>
impl<'w, 's, T> !UnwindSafe for Raycast<'w, 's, T>
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> 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
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
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
.§fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§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.§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.