Struct bevy::input::touch::TouchInput

pub struct TouchInput {
    pub phase: TouchPhase,
    pub position: Vec2,
    pub window: Entity,
    pub force: Option<ForceTouch>,
    pub id: u64,
}

A touch input event.

Logic

Every time the user touches the screen, a new TouchPhase::Started event with an unique identifier for the finger is generated. When the finger is lifted, the TouchPhase::Ended event is generated with the same finger id.

After a TouchPhase::Started event has been emitted, there may be zero or more TouchPhase::Moved events when the finger is moved or the touch pressure changes.

The finger id may be reused by the system after an TouchPhase::Ended event. The user should assume that a new TouchPhase::Started event received with the same id has nothing to do with the old finger and is a new finger.

A TouchPhase::Canceled event is emitted when the system has canceled tracking this touch, such as when the window loses focus, or on iOS if the user moves the device against their face.

Note

This event is the translated version of the WindowEvent::Touch from the winit crate. It is available to the end user and can be used for game logic.

Fields

phase: TouchPhase

The phase of the touch input.

position: Vec2

The position of the finger on the touchscreen.

window: Entity

The window entity registering the touch.

force: Option<ForceTouch>

Describes how hard the screen was pressed.

May be None if the platform does not support pressure sensitivity. This feature is only available on iOS 9.0+ and Windows 8+.

id: u64

The unique identifier of the finger.

Trait Implementations

impl Clone for TouchInput

fn clone(&self) -> TouchInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TouchInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TouchInput

fn deserialize<__D>( __deserializer: __D ) -> Result<TouchInput, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&TouchInput> for Touch

fn from(input: &TouchInput) -> Touch

Converts to this type from the input type.

impl From<TouchInput> for WinitEvent

fn from(e: TouchInput) -> WinitEvent

Converts to this type from the input type.

impl FromReflect for TouchInput

where TouchInput: Any + Send + Sync, TouchPhase: FromReflect + TypePath + RegisterForReflection, Vec2: FromReflect + TypePath + RegisterForReflection, Entity: FromReflect + TypePath + RegisterForReflection, Option<ForceTouch>: FromReflect + TypePath + RegisterForReflection, u64: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<TouchInput>

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 GetTypeRegistration for TouchInput

where TouchInput: Any + Send + Sync, TouchPhase: FromReflect + TypePath + RegisterForReflection, Vec2: FromReflect + TypePath + RegisterForReflection, Entity: FromReflect + TypePath + RegisterForReflection, Option<ForceTouch>: FromReflect + TypePath + RegisterForReflection, u64: 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 PartialEq for TouchInput

fn eq(&self, other: &TouchInput) -> 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 TouchInput

where TouchInput: Any + Send + Sync, TouchPhase: FromReflect + TypePath + RegisterForReflection, Vec2: FromReflect + TypePath + RegisterForReflection, Entity: FromReflect + TypePath + RegisterForReflection, Option<ForceTouch>: FromReflect + TypePath + RegisterForReflection, u64: 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<TouchInput>) -> Box<dyn Any>

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<TouchInput>) -> Box<dyn Reflect>

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>

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 apply(&mut self, value: &(dyn Reflect + 'static))

Applies 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<TouchInput>) -> ReflectOwned

Returns an owned enumeration of “kinds” of 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 reflect_hash(&self) -> Option<u64>

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

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 Serialize for TouchInput

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for TouchInput

where TouchInput: Any + Send + Sync, TouchPhase: FromReflect + TypePath + RegisterForReflection, Vec2: FromReflect + TypePath + RegisterForReflection, Entity: FromReflect + TypePath + RegisterForReflection, Option<ForceTouch>: FromReflect + TypePath + RegisterForReflection, u64: FromReflect + TypePath + RegisterForReflection,

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

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 + 'static)>

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 + 'static)>

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 + 'static)>

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 TypePath for TouchInput

where TouchInput: Any + Send + Sync,

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 Typed for TouchInput

where TouchInput: Any + Send + Sync, TouchPhase: FromReflect + TypePath + RegisterForReflection, Vec2: FromReflect + TypePath + RegisterForReflection, Entity: FromReflect + TypePath + RegisterForReflection, Option<ForceTouch>: FromReflect + TypePath + RegisterForReflection, u64: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for TouchInput

impl Event for TouchInput

where TouchInput: Send + Sync + 'static,

impl StructuralPartialEq for TouchInput