Struct Kinetic 

pub struct Kinetic { /* private fields */ }

Kinetic scrolling model

Implementations

impl Kinetic

pub fn press_start(&mut self, press: PressSource)

Call on Event::PressStart

pub fn press_move(&mut self, press: PressSource) -> bool

Call on Event::PressMove

Returns true if component should immediately scroll by delta

pub fn press_end(&mut self, press: PressSource, vel: Vec2) -> bool

Call on Event::PressEnd

Returns true when a frame timer (EventState::request_frame_timer) should be requested (see Self::step).

pub fn start(&mut self, start: KineticStart) -> Offset

Call on Scroll::Kinetic to immediately start (or accelerate) scrolling

Returns any offset which should be applied immediately.

pub fn step(&mut self, cx: &EventState) -> Option<Offset>

Call this regularly using a frame timer

On Self::press_end and while in motion (Self::is_scrolling), a frame timer (EventState::request_frame_timer) should be requested and used to call this method.

pub fn stop(&mut self)

Stop scrolling immediately

pub fn stop_with_residual(&mut self, delta: Offset) -> KineticStart

Stop scrolling on any axis were delta is non-zero

Returns a KineticStart message from the residual velocity and delta.

pub fn is_scrolling(&self) -> bool

True while kinetic scrolling

Trait Implementations

impl Clone for Kinetic

fn clone(&self) -> Kinetic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Kinetic

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

Formats the value using the given formatter.

impl Default for Kinetic

fn default() -> Self

Returns the “default value” for a type.