Skip to main content

StrokeInput

Struct StrokeInput 

Source
pub struct StrokeInput {
    pub tool_type: ToolType,
    pub position: Point,
    pub elapsed_time: Duration,
    pub stroke_unit_length_cm: Option<f32>,
    pub pressure: Option<f32>,
    pub tilt: Option<f32>,
    pub orientation: Option<f32>,
    pub barrel_twist: Option<f32>,
}
Expand description

One sampled input event.

Every field but tool_type, position and elapsed_time is optional, and all the inputs in a batch have to agree on which ones are present. Mixing, say, some events with pressure and some without is rejected when the batch is built.

Fields§

§tool_type: ToolType

What produced the event.

§position: Point

Where it happened, in stroke units.

§elapsed_time: Duration

Time since the start of the stroke.

§stroke_unit_length_cm: Option<f32>

How long one stroke unit is, in centimetres. Needed by brush behaviours that work in physical units.

§pressure: Option<f32>

Stylus or touch pressure, normally in 0.0..=1.0.

§tilt: Option<f32>

Stylus tilt away from perpendicular, in radians.

§orientation: Option<f32>

Direction the stylus is tilted towards, in radians.

§barrel_twist: Option<f32>

Rotation of the stylus about its own axis, in radians.

Implementations§

Source§

impl StrokeInput

Source

pub fn new(tool_type: ToolType, position: Point, elapsed_time: Duration) -> Self

The minimum an input needs: where and when.

Source

pub fn with_pressure(self, pressure: f32) -> Self

Adds pressure to an input.

Source

pub fn with_tilt_orientation(self, tilt: f32, orientation: f32) -> Self

Adds stylus tilt and orientation, both in radians.

Trait Implementations§

Source§

impl Clone for StrokeInput

Source§

fn clone(&self) -> StrokeInput

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 StrokeInput

Source§

impl Debug for StrokeInput

Source§

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

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

impl Default for StrokeInput

Source§

fn default() -> StrokeInput

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

impl PartialEq for StrokeInput

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StrokeInput

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.