PointerProperties

Struct PointerProperties 

Source
pub struct PointerProperties { /* private fields */ }
Expand description

Describes a pointer’s values, typically at the time of a pointer event

Implementations§

Source§

impl PointerProperties

Source

pub fn builder() -> PointerPropertiesBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building PointerProperties. On the builder, call .coordinates(...), .held_buttons(...), .id(...), .dimensions(...)(optional), .pressure(...)(optional), .tangential_pressure(...)(optional), .orientation(...)(optional), .pointer_type(...), .is_primary(...) to set the values of the fields. Finally, call .build() to create the instance of PointerProperties.

Source§

impl PointerProperties

Source

pub fn coordinates(&self) -> &Coordinates

Coordinates in user interface

Source

pub fn held_buttons(&self) -> PointerButtonSet

Pointer buttons held at time of event

Source

pub fn id(&self) -> PointerId

Unique pointer ID

Source

pub fn dimensions(&self) -> Size2D<f64, Pixels>

Dimensions of pointer

Source

pub fn pressure(&self) -> f64

The normalized pressure of the pointer input in the range of [0,1]

0 and 1 represent the minimum and maximum pressure the hardware is capable of detecting, respectively.

Source

pub fn tangential_pressure(&self) -> f64

The normalized tangential pressure of pointer in the range of [-1,1]

Typically set by an additional control (e.g. a finger wheel on an airbrush stylus). Also known as barrel pressure.

0 is the neutral position of the control. Note that some hardware may only support positive values in the range of [0,1]

Source

pub fn orientation(&self) -> &PointerOrientation

The pointer’s orientation (tilt or spherical angles, and twist)

Source

pub fn pointer_type(&self) -> PointerType

The device type

Source

pub fn is_primary(&self) -> bool

In a multi-pointer (e.g. multi-touch) scenario, used to identify a master pointer amongst the set of active pointers for each pointer type.

  • At any given time, there can be at most one primary pointer for each pointer type.
  • The first pointer to become active for a particular pointer type (e.g. the first finger to touch the screen in a multi-touch interaction) becomes the primary pointer for that pointer type.

Trait Implementations§

Source§

impl Clone for PointerProperties

Source§

fn clone(&self) -> PointerProperties

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PointerProperties

Source§

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

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

impl PartialEq for PointerProperties

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PointerProperties

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

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

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.