Skip to main content

ClampingScrollSimulation

Struct ClampingScrollSimulation 

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

A fling that decelerates like Android’s OverScroller, then stops dead.

The curve is the one Android’s SplineOverScroller uses for a fling: distance and duration are derived from the release velocity, and the position follows 1 − (1 − t)^r over that duration. It never leaves the content: reaching an edge is the caller’s business (see the clamping scroll policy), which is what makes it the right model for a platform with no bounce.

Adjusted, as Flutter’s is, to be ballistic — deceleration depends only on the current velocity, never on how long ago the motion started — so a fling can be restarted mid-flight from its own state alone.

Implementations§

Source§

impl ClampingScrollSimulation

Source

pub fn new(position: f32, velocity: f32, tolerance: Tolerance) -> Self

A fling from position at velocity (px/s), with Android’s friction.

Source

pub fn with_friction( position: f32, velocity: f32, friction: f32, tolerance: Tolerance, ) -> Self

The same fling, with the friction coefficient made explicit: higher means it stops sooner and travels less far.

Source

pub fn duration(&self) -> f32

The total run time, in seconds.

Source

pub fn final_x(&self) -> f32

Where the fling comes to rest.

Trait Implementations§

Source§

impl Clone for ClampingScrollSimulation

Source§

fn clone(&self) -> Self

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 ClampingScrollSimulation

Source§

impl Debug for ClampingScrollSimulation

Source§

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

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

impl Simulation for ClampingScrollSimulation

Source§

fn x(&self, time: f32) -> f32

The position at instant time.
Source§

fn dx(&self, time: f32) -> f32

The velocity — the derivative of position — at instant time.
Source§

fn is_done(&self, time: f32) -> bool

true once the motion has finished, within the tolerances.
Source§

fn tolerance(&self) -> Tolerance

The stopping thresholds.

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 = !

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.