Enum bevy_mod_picking::pointer::PointerId

pub enum PointerId {
    Mouse,
    Touch(u64),
    Custom(Uuid),
}

Identifies a unique pointer entity. Mouse and Touch pointers are automatically spawned.

This component is needed because pointers can be spawned and despawned, but they need to have a stable ID that persists regardless of the Entity they are associated with.

Variants

Mouse

The mouse pointer.

Touch(u64)

A touch input, usually numbered by window touch events from winit.

Custom(Uuid)

A custom, uniquely identified pointer. Useful for mocking inputs or implementing a software controlled cursor.

Implementations

impl PointerId

pub fn is_touch(&self) -> bool

Returns true if the pointer is a touch input.

pub fn is_mouse(&self) -> bool

Returns true if the pointer is the mouse.

pub fn is_custom(&self) -> bool

Returns true if the pointer is a custom input.

pub fn get_touch_id(&self) -> Option<u64>

Returns the touch id if the pointer is a touch input.

Trait Implementations

impl Clone for PointerId

fn clone(&self) -> PointerId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for PointerIdwhere PointerId: Send + Sync + 'static,

type Storage = TableStorage

impl Debug for PointerId

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

Formats the value using the given formatter.

impl GetTypeRegistration for PointerId

fn get_type_registration() -> TypeRegistration

impl Hash for PointerId

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<PointerId> for PointerId

fn eq(&self, other: &PointerId) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for PointerId

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the [TypeInfo] of the underlying type.

fn into_any(self: Box<PointerId, Global>) -> Box<dyn Any, Global>

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<PointerId, Global>) -> Box<dyn Reflect, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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

Applies a reflected value to this value.

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

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

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

Returns an enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<PointerId, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

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

fn reflect_partial_eq(&self, _value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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.

impl Typed for PointerId

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for PointerId

impl Eq for PointerId

impl StructuralEq for PointerId

impl StructuralPartialEq for PointerId