Struct RaycastSource

pub struct RaycastSource<T: TypePath> {
    pub cast_method: RaycastMethod,
    pub should_early_exit: bool,
    pub visibility: RaycastVisibility,
    pub ray: Option<Ray3d>,
    /* private fields */
}

The RaycastSource component is used to generate rays with the specified cast_method. A ray is generated when the RaycastSource is initialized, either by waiting for update_raycast system to process the ray, or by using a with_ray function.`

Fields

cast_method: RaycastMethod

The method used to generate rays for this raycast.

should_early_exit: bool

When true, raycasting will only hit the nearest entity, skipping any entities that are further away. This can significantly improve performance in cases where a ray intersects many AABBs.

visibility: RaycastVisibility

Determines how raycasting should consider entity visibility.

ray: Option<Ray3d>

Implementations

impl<T: TypePath> RaycastSource<T>

pub fn new() -> RaycastSource<T>

Instantiates a RaycastSource. It will not be initialized until the update_raycast system runs, or one of the with_ray functions is run.

pub fn with_ray_screenspace( self, cursor_pos_screen: Vec2, camera: &Camera, camera_transform: &GlobalTransform, window: &Window, ) -> Self

Initializes a RaycastSource with a valid screenspace ray.

pub fn with_ray_transform(self, transform: Mat4) -> Self

Initializes a RaycastSource with a valid ray derived from a transform.

pub fn with_early_exit(self, should_early_exit: bool) -> Self

Set the should_early_exit field of this raycast source.

pub fn with_visibility(self, visibility: RaycastVisibility) -> Self

Set the visibility field of this raycast source.

pub fn new_screenspace( cursor_pos_screen: Vec2, camera: &Camera, camera_transform: &GlobalTransform, window: &Window, ) -> Self

Instantiates and initializes a RaycastSource with a valid screenspace ray.

pub fn new_cursor() -> Self

Initializes a RaycastSource for cursor raycasting.

pub fn new_transform(transform: Mat4) -> Self

Initializes a RaycastSource with a valid ray derived from a transform.

pub fn new_transform_empty() -> Self

Instantiates a RaycastSource with RaycastMethod::Transform, and an empty ray. It will not be initialized until the update_raycast system is run and a GlobalTransform is present on this entity.

Warning

Only use this if the entity this is associated with will have its Transform or GlobalTransform specified elsewhere. If the GlobalTransform is not set, this ray casting source will never be able to generate a raycast.

pub fn get_intersections(&self) -> Option<&[(Entity, IntersectionData)]>

Get a reference to the ray cast source’s intersections, if one exists.

pub fn intersections(&self) -> &[(Entity, IntersectionData)]

Get a reference to the ray cast source’s intersections. Returns an empty list if there are no intersections.

pub fn get_nearest_intersection(&self) -> Option<(Entity, &IntersectionData)>

Get a reference to the nearest intersection point, if there is one.

pub fn get_ray(&self) -> Option<Ray3d>

Get a copy of the ray cast source’s ray.

pub fn intersections_mut(&mut self) -> &mut Vec<(Entity, IntersectionData)>

Get a mutable reference to the ray cast source’s intersections.

pub fn is_screenspace(&self) -> bool

Returns true if this is using RaycastMethod::Screenspace.

Trait Implementations

impl<T: TypePath> Clone for RaycastSource<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: TypePath> Component for RaycastSource<T>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl<T: TypePath> Default for RaycastSource<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> FromReflect for RaycastSource<T>

where Self: Any + Send + Sync, T: TypePath + TypePath, RaycastMethod: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, RaycastVisibility: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect>, ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<T> GetTypeRegistration for RaycastSource<T>

where Self: Any + Send + Sync, T: TypePath + TypePath, RaycastMethod: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, RaycastVisibility: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<T> Reflect for RaycastSource<T>

where Self: Any + Send + Sync, T: TypePath + TypePath, RaycastMethod: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, RaycastVisibility: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<T> Struct for RaycastSource<T>

where Self: Any + Send + Sync, T: TypePath + TypePath, RaycastMethod: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, RaycastVisibility: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl<T> TypePath for RaycastSource<T>

where Self: Any + Send + Sync, T: TypePath + TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl<T> Typed for RaycastSource<T>

where Self: Any + Send + Sync, T: TypePath + TypePath, RaycastMethod: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, RaycastVisibility: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.