Struct bevy_mod_picking::RayCastSource

source · [−]

pub struct RayCastSource<T> {
    pub cast_method: RayCastMethod,
    /* private fields */
}

Expand description

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

source

impl<T> RayCastSource<T>

source

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.

source

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.

source

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

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

source

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.

source

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

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

source

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.

source

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

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

source

pub fn intersections_mut(&mut self) -> &mut Vec<(Entity, Intersection ), Global>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

Trait Implementations

source

impl<T> Component for RayCastSource<T> where
 RayCastSource<T>: 'static,
 RayCastSource<T>: Send,
 RayCastSource<T>: Sync,

type Storage = TableStorage

source

impl<T> Default for RayCastSource<T>

source

pub fn default() -> RayCastSource<T>

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for RayCastSource<T> where
T: RefUnwindSafe,

impl<T> Send for RayCastSource<T> where
T: Send,

impl<T> Sync for RayCastSource<T> where
T: Sync,

impl<T> Unpin for RayCastSource<T> where
T: Unpin,

impl<T> UnwindSafe for RayCastSource<T> where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, 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. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub 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. Read more

pub 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. Read more

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

impl<T> DowncastSync for T where
T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T> FromWorld for T where
T: Default,

pub fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World]

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> Upcast<T> for T

pub fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct bevy_mod_picking::RayCastSource

Fields

Implementations

impl<T> RayCastSource<T>

pub fn new() -> RayCastSource<T>

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

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

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

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

pub fn new_transform_empty() -> RayCastSource<T>

Warning

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>

pub fn intersections_mut(&mut self) -> &mut Vec<(Entity, Intersection), Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

Trait Implementations

impl<T> Component for RayCastSource<T> where RayCastSource<T>: 'static, RayCastSource<T>: Send, RayCastSource<T>: Sync,

type Storage = TableStorage

impl<T> Default for RayCastSource<T>

pub fn default() -> RayCastSource<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for RayCastSource<T> where T: RefUnwindSafe,

impl<T> Send for RayCastSource<T> where T: Send,

impl<T> Sync for RayCastSource<T> where T: Sync,

impl<T> Unpin for RayCastSource<T> where T: Unpin,

impl<T> UnwindSafe for RayCastSource<T> where T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

impl<T> DowncastSync for T where T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> FromWorld for T where T: Default,

pub fn from_world(_world: &mut World) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Upcast<T> for T

pub fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Resource for T where T: 'static + Send + Sync,

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

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

pub fn intersect_list(&self) -> Option<&Vec<(Entity, Intersection ), Global>>

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

pub fn intersections_mut(&mut self) -> &mut Vec<(Entity, Intersection ), Global>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<T> Component for RayCastSource<T> where
RayCastSource<T>: 'static,
RayCastSource<T>: Send,
RayCastSource<T>: Sync,

impl<T> RefUnwindSafe for RayCastSource<T> where
T: RefUnwindSafe,

impl<T> Send for RayCastSource<T> where
T: Send,

impl<T> Sync for RayCastSource<T> where
T: Sync,

impl<T> Unpin for RayCastSource<T> where
T: Unpin,

impl<T> UnwindSafe for RayCastSource<T> where
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T> FromWorld for T where
T: Default,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Resource for T where
T: 'static + Send + Sync,