Skip to main content

MomentumScroller

Struct MomentumScroller 

Source
pub struct MomentumScroller {
    pub position: f32,
    pub scale: f32,
    pub velocity: f32,
    pub friction: f32,
    pub min_velocity: f32,
}
Expand description

Scroll offset with velocity-based momentum and frame-rate-independent friction.

Fields§

§position: f32

Current scroll offset on this axis.

§scale: f32

Multiplier applied to scroll deltas.

§velocity: f32

Current scroll velocity in pixels per second.

§friction: f32

Stored friction factor (1.0 − friction passed to new).

Momentum decay uses friction.powf(dt * 60.0) each frame.

§min_velocity: f32

Velocity magnitudes below this threshold are zeroed out.

Implementations§

Source§

impl MomentumScroller

Source

pub fn new(scale: f32, friction: f32, min_velocity: f32) -> Self

Creates a momentum scroller at position zero.

  • scale — multiplier for scroll deltas.
  • friction — per-60-fps-step decay factor; must satisfy 0.0 < friction < 1.0. Stored internally as 1.0 - friction.
  • min_velocity — stop threshold; must be positive.
§Panics

Panics if friction is not in (0.0, 1.0) or if min_velocity <= 0.0.

Source

pub fn direct_set_position(&mut self, position: f32)

Sets the scroll position and clears velocity.

Source

pub fn update(&mut self, d_scroll: f32, dt: f32)

Advances scroll state for one frame.

When d_scroll != 0, applies the delta and sets velocity from d_scroll / dt. When d_scroll == 0, applies momentum with friction decay.

§Examples
use cotis_interactivity::scroll::MomentumScroller;

let mut scroller = MomentumScroller::new(1.0, 0.1, 0.5);
scroller.update(10.0, 1.0 / 60.0);
assert!(scroller.get_position() > 0.0);

// Momentum continues when no new delta is applied
scroller.update(0.0, 1.0 / 60.0);
assert!(scroller.velocity.abs() > 0.0 || scroller.get_position() > 10.0);
Source

pub fn get_position(&self) -> f32

Returns the current scroll offset.

Trait Implementations§

Source§

impl Clone for MomentumScroller

Source§

fn clone(&self) -> MomentumScroller

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 MomentumScroller

Source§

impl Debug for MomentumScroller

Source§

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

Formats the value using the given formatter. Read more

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.