Skip to main content

SpringSpec

Struct SpringSpec 

Source
pub struct SpringSpec {
    pub duration: f32,
    pub bounce: f32,
}
Expand description

A spring described the way designers tune one: how long it takes to settle, and how much it bounces.

duration is the period of the undamped spring in seconds, which is close to how long the motion reads as taking. bounce runs from -1 to 1: 0 settles as fast as possible without overshooting, positive values overshoot and oscillate, and negative values approach more gently.

Fields§

§duration: f32§bounce: f32

Implementations§

Source§

impl SpringSpec

Source

pub const SMOOTH: SpringSpec

Settles without overshoot.

Source

pub const SNAPPY: SpringSpec

Quick, with a hint of overshoot.

Source

pub const BOUNCY: SpringSpec

Visibly overshoots and settles back.

Source

pub const REST_THRESHOLD: f64 = 1.0e-3

How far from rest, as a share of the distance travelled, a spring counts as settled.

Source

pub const fn new(duration: f32, bounce: f32) -> SpringSpec

Source

pub fn from_physics(stiffness: f32, damping: f32) -> SpringSpec

The spec matching a unit-mass spring with this stiffness and damping.

Source

pub fn stiffness(self) -> f32

Stiffness of the equivalent unit-mass spring.

Source

pub fn damping(self) -> f32

Damping of the equivalent unit-mass spring.

Source

pub fn damping_ratio(self) -> f32

The damping ratio: below 1 oscillates, 1 is critically damped.

Source

pub fn progress(self, elapsed: f64) -> f32

Progress from 0 to 1 after elapsed seconds of a spring released from rest. Bouncy springs overshoot past 1 before settling.

Source

pub fn settling_duration(self) -> f64

Seconds until a spring released from rest stays within SpringSpec::REST_THRESHOLD of its target.

Trait Implementations§

Source§

impl Clone for SpringSpec

Source§

fn clone(&self) -> SpringSpec

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 SpringSpec

Source§

impl Debug for SpringSpec

Source§

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

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

impl Default for SpringSpec

Source§

fn default() -> SpringSpec

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

impl From<SpringSpec> for AnimationSpec

Source§

fn from(spring: SpringSpec) -> AnimationSpec

Converts to this type from the input type.
Source§

impl PartialEq for SpringSpec

Source§

fn eq(&self, other: &SpringSpec) -> 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 SpringSpec

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.