Skip to main content

Spring

Struct Spring 

Source
pub struct Spring {
    pub stiffness: f64,
    pub damping: f64,
    pub mass: f64,
    pub initial_velocity: f64,
    pub epsilon: f64,
}
Expand description

A damped spring.

Springs are described by how they feel — how stiff, how damped, how heavy — rather than by a duration, and they settle when they settle. That is why they are worth having next to the fixed-duration curves: a window flung by a gesture should carry the gesture’s velocity into its animation, which no amount of easing curve can express.

Fields§

§stiffness: f64

How hard it pulls toward the target. Higher is faster and snappier.

§damping: f64

How much it resists moving. Higher settles sooner with less overshoot.

§mass: f64

How heavy the thing being moved is. Higher is slower and more sluggish.

§initial_velocity: f64

Velocity at the start, in fractions of the distance per second. A gesture’s throw speed goes here.

§epsilon: f64

How close counts as arrived.

Implementations§

Source§

impl Spring

Source

pub fn value_at(&self, seconds: f64) -> f64

The fraction of the way to the target at seconds.

Solved in closed form rather than integrated step by step, so the value depends only on the time asked for. A stepped simulation would give different answers at different frame rates, which is precisely the bug that makes an animation feel different on a 60 Hz screen than on a 260 Hz one.

Source

pub fn settle_time(&self) -> Duration

Roughly when it stops moving, so a caller knows when to stop asking.

Found by walking forward rather than solved, because the exact answer needs the Lambert W function and this is only ever used to decide when to drop an animation.

Trait Implementations§

Source§

impl Clone for Spring

Source§

fn clone(&self) -> Spring

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 Spring

Source§

impl Debug for Spring

Source§

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

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

impl Default for Spring

Source§

fn default() -> Self

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

impl PartialEq for Spring

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Spring

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.