Struct avian3d::spatial_query::RayCaster
source · pub struct RayCaster {
pub enabled: bool,
pub origin: Vector,
pub direction: Dir3,
pub max_time_of_impact: Scalar,
pub max_hits: u32,
pub solid: bool,
pub ignore_self: bool,
pub query_filter: SpatialQueryFilter,
/* private fields */
}
Expand description
A component used for raycasting.
Raycasting is a type of spatial query that finds one or more hits between a ray and a set of colliders.
Each ray is defined by a local origin
and a direction
. The RayCaster
will find each hit
and add them to the RayHits
component. Each hit has a time_of_impact
property
which refers to how long the ray travelled, i.e. the distance between the origin
and the point of intersection.
The RayCaster
is the easiest way to handle simple raycasts. If you want more control and don’t want to
perform raycasts every frame, consider using the SpatialQuery
system parameter.
§Hit count and order
The results of a raycast are in an arbitrary order by default. You can iterate over them in the order of
time of impact with the RayHits::iter_sorted
method.
You can configure the maximum amount of hits for a ray using max_hits
. By default this is unbounded,
so you will get all hits. When the number or complexity of colliders is large, this can be very
expensive computationally. Set the value to whatever works best for your case.
Note that when there are more hits than max_hits
, some hits will be missed.
To guarantee that the closest hit is included, you should set max_hits
to one or a value that
is enough to contain all hits.
§Example
use avian3d::prelude::*;
use bevy::prelude::*;
fn setup(mut commands: Commands) {
// Spawn a ray at the center going right
commands.spawn(RayCaster::new(Vec3::ZERO, Dir3::X));
// ...spawn colliders and other things
}
fn print_hits(query: Query<(&RayCaster, &RayHits)>) {
for (ray, hits) in &query {
// For the faster iterator that isn't sorted, use `.iter()`
for hit in hits.iter_sorted() {
println!(
"Hit entity {:?} at {} with normal {}",
hit.entity,
ray.origin + *ray.direction * hit.time_of_impact,
hit.normal,
);
}
}
}
Fields§
§enabled: bool
Controls if the ray caster is enabled.
origin: Vector
The local origin of the ray relative to the Position
and Rotation
of the ray entity or its parent.
To get the global origin, use the global_origin
method.
direction: Dir3
The local direction of the ray relative to the Rotation
of the ray entity or its parent.
To get the global direction, use the global_direction
method.
max_time_of_impact: Scalar
The maximum distance the ray can travel. By default this is infinite, so the ray will travel
until all hits up to max_hits
have been checked.
max_hits: u32
The maximum number of hits allowed.
When there are more hits than max_hits
, some hits will be missed.
To guarantee that the closest hit is included, you should set max_hits
to one or a value that
is enough to contain all hits.
solid: bool
Controls how the ray behaves when the ray origin is inside of a collider.
If solid
is true, the point of intersection will be the ray origin itself.
If solid
is false, the collider will be considered to have no interior, and the point of intersection
will be at the collider shape’s boundary.
ignore_self: bool
If true, the ray caster ignores hits against its own Collider
. This is the default.
query_filter: SpatialQueryFilter
Rules that determine which colliders are taken into account in the query.
Implementations§
source§impl RayCaster
impl RayCaster
sourcepub fn new(origin: Vector, direction: Dir3) -> Self
pub fn new(origin: Vector, direction: Dir3) -> Self
Creates a new RayCaster
with a given origin and direction.
sourcepub fn with_origin(self, origin: Vector) -> Self
pub fn with_origin(self, origin: Vector) -> Self
Sets the ray origin.
sourcepub fn with_direction(self, direction: Dir3) -> Self
pub fn with_direction(self, direction: Dir3) -> Self
Sets the ray direction.
sourcepub fn with_solidness(self, solid: bool) -> Self
pub fn with_solidness(self, solid: bool) -> Self
Sets if the ray treats colliders as solid.
If solid
is true, the point of intersection will be the ray origin itself.
If solid
is false, the collider will be considered to have no interior, and the point of intersection
will be at the collider shape’s boundary.
sourcepub fn with_ignore_self(self, ignore: bool) -> Self
pub fn with_ignore_self(self, ignore: bool) -> Self
Sets if the ray caster should ignore hits against its own Collider
.
The default is true.
sourcepub fn with_max_time_of_impact(self, max_time_of_impact: Scalar) -> Self
pub fn with_max_time_of_impact(self, max_time_of_impact: Scalar) -> Self
Sets the maximum time of impact, i.e. the maximum distance that the ray is allowed to travel.
sourcepub fn with_max_hits(self, max_hits: u32) -> Self
pub fn with_max_hits(self, max_hits: u32) -> Self
Sets the maximum number of allowed hits.
sourcepub fn with_query_filter(self, query_filter: SpatialQueryFilter) -> Self
pub fn with_query_filter(self, query_filter: SpatialQueryFilter) -> Self
Sets the ray caster’s query filter that controls which colliders should be included or excluded by raycasts.
sourcepub fn global_origin(&self) -> Vector
pub fn global_origin(&self) -> Vector
Returns the global origin of the ray.
sourcepub fn global_direction(&self) -> Dir3
pub fn global_direction(&self) -> Dir3
Returns the global direction of the ray.
Trait Implementations§
source§impl Component for RayCaster
impl Component for RayCaster
source§const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table
const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table
source§fn register_component_hooks(_hooks: &mut ComponentHooks)
fn register_component_hooks(_hooks: &mut ComponentHooks)
ComponentHooks
.source§impl FromReflect for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
impl FromReflect for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
source§fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
Self
from a reflected value.source§fn take_from_reflect(
reflect: Box<dyn Reflect>
) -> Result<Self, Box<dyn Reflect>>
fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>
Self
using,
constructing the value using from_reflect
if that fails. Read moresource§impl GetTypeRegistration for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
impl GetTypeRegistration for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
source§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.source§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
source§impl PartialEq for RayCaster
impl PartialEq for RayCaster
source§impl Reflect for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
impl Reflect for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl Struct for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
impl Struct for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
source§fn field(&self, name: &str) -> Option<&dyn Reflect>
fn field(&self, name: &str) -> Option<&dyn Reflect>
name
as a &dyn Reflect
.source§fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
name
as a
&mut dyn Reflect
.source§fn field_at(&self, index: usize) -> Option<&dyn Reflect>
fn field_at(&self, index: usize) -> Option<&dyn Reflect>
index
as a
&dyn Reflect
.source§fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
index
as a &mut dyn Reflect
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl TypePath for RayCaster
impl TypePath for RayCaster
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl Typed for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
impl Typed for RayCasterwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Dir3: FromReflect + TypePath + RegisterForReflection,
Scalar: FromReflect + TypePath + RegisterForReflection,
u32: FromReflect + TypePath + RegisterForReflection,
SpatialQueryFilter: FromReflect + TypePath + RegisterForReflection,
impl StructuralPartialEq for RayCaster
Auto Trait Implementations§
impl Freeze for RayCaster
impl RefUnwindSafe for RayCaster
impl Send for RayCaster
impl Sync for RayCaster
impl Unpin for RayCaster
impl UnwindSafe for RayCaster
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
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
source§impl<C> Bundle for Cwhere
C: Component,
impl<C> Bundle for Cwhere
C: Component,
fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId) )
unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
source§fn get_component_ids(
components: &Components,
ids: &mut impl FnMut(Option<ComponentId>)
)
fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>) )
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>
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>
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)
&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)
&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<C> DynamicBundle for Cwhere
C: Component,
impl<C> DynamicBundle for Cwhere
C: Component,
fn get_components(self, func: &mut impl FnMut(StorageType, OwningPtr<'_>))
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
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
Self
using data from the given World
.source§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
source§impl<T> GetPath for T
impl<T> GetPath for T
source§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§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>
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>
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 moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.