Skip to main content

TouchPhase

Enum TouchPhase 

Source
pub enum TouchPhase {
    Began,
    Moved,
    Ended,
    Cancelled,
}
Expand description

Input vocabulary, defined in crcbl_core::input and re-exported so a consumer of the event stream needs one use rather than two.

See the crate docs for why these live in crcbl-core. Where a ContactId is in its gesture.

A touchscreen has no “hover”: a contact exists from the moment it lands until the moment it goes away, so this is the lifecycle rather than a button state — which is why touch does not reuse ButtonState.

Variants§

§

Began

The finger landed. The first event any ContactId gets.

§

Moved

It moved while down.

§

Ended

The user lifted it. The gesture completed, and a consumer commits whatever it meant — a tap fires, a stick centres, a drag lands where it was let go.

§

Cancelled

The system took the gesture away: the OS claimed it for an edge swipe, palm rejection changed its mind, the window lost focus, the browser decided the page was scrolling after all.

Not an Ended, and a consumer that treats it as one fires actions the user did not ask for. The position it carries is the last one the platform knew, not a place anyone chose, so the answer is to undo the interaction rather than complete it — the drag goes back, the tap does not fire, the stick centres without the character having lunged. What both share is that the contact is over: the id is gone either way, and a consumer that ignores this one is left holding a finger that will never move again.

Implementations§

Source§

impl TouchPhase

Source

pub const fn ends_contact(self) -> bool

Whether this phase ends the contact — Ended or Cancelled.

The test anything tracking live contacts writes; it is the reason they differ that the two variants exist for, not the fact that they both stop.

Source

pub const fn as_str(self) -> &'static str

A short, stable name for logs and test assertions.

Trait Implementations§

Source§

impl Clone for TouchPhase

Source§

fn clone(&self) -> TouchPhase

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TouchPhase

Source§

impl Debug for TouchPhase

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for TouchPhase

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for TouchPhase

Source§

impl Hash for TouchPhase

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for TouchPhase

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TouchPhase

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.