Struct bevy_mod_picking::RayCastSource

pub struct RayCastSource<T> {
    pub cast_method: RayCastMethod,
    // some fields omitted
}

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

Implementations

impl<T> 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,
    windows: &Res<'_, Windows>,
    camera: &Camera,
    camera_transform: &GlobalTransform
) -> RayCastSource<T>

Initializes a RayCastSource with a valid screenspace ray.

pub fn with_ray_transform(&self, transform: Mat4) -> RayCastSource<T>

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

pub fn new_screenspace(
    cursor_pos_screen: Vec2,
    windows: &Res<'_, Windows>,
    camera: &Camera,
    camera_transform: &GlobalTransform
) -> RayCastSource<T>

Instantiates and initializes a RayCastSource with a valid screenspace ray.

pub fn new_transform(transform: Mat4) -> RayCastSource<T>

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

pub fn new_transform_empty() -> RayCastSource<T>

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 intersect_list(&self) -> Option<&Vec<(Entity, Intersection), Global>>

pub fn intersect_top(&self) -> Option<(Entity, Intersection)>

pub fn intersect_primitive(&self, shape: Primitive3d) -> Option<Intersection>

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

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

Trait Implementations

impl<T> Default for RayCastSource<T>

pub fn default() -> RayCastSource<T>

Returns the “default value” for a type.