Skip to main content

Spring

Struct Spring 

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

A damped spring: what pulls a value toward its target.

Fields§

§stiffness: f64

How hard it pulls. Higher is faster.

§damping: f64

How much it resists motion. Lower overshoots more.

§mass: f64

The weight it moves. Higher is slower and overshoots more.

Implementations§

Source§

impl Spring

Source

pub const fn new(stiffness: f64, damping: f64) -> Spring

A spring of mass 1 with this stiffness and damping.

Source

pub const fn mass(self, mass: f64) -> Spring

The spring with another mass.

Source

pub fn from_response(response: f64, ratio: f64) -> Spring

The spring an AnimSpec::spring of this response (the period of the undamped oscillation, in seconds) and damping ratio describes, with a mass of 1: the same motion on the frame-driven path as a native spring animation of that spec.

Source

pub fn curve(self) -> Curve

The spring as an animation curve: its response and damping ratio, for AnimSpec. AnimSpec::spring(response, ratio) with these two is the native animation that matches this spring released at rest.

Source

pub fn step(self, state: &mut SpringState, target: f64, dt: f64)

Advances state toward target by dt seconds. A long frame is split into steps of at most a millisecond, so a stiff spring stays stable when the display stalls.

Source

pub fn settled(self, state: SpringState, target: f64) -> bool

Whether state has come to rest on target: both its distance and its speed are below what a display can show.

Source

pub fn response(self, seconds: f64, count: usize) -> Vec<f64>

The spring’s answer to a step from 0 to 1, sampled at count evenly spaced times over seconds, for plotting it.

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<(), Error>

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

impl Default for Spring

Source§

fn default() -> Spring

A spring that settles without visible overshoot: stiffness 170, damping 26, mass 1.

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§

§

impl Forget for Spring

§

impl Freeze for Spring

§

impl Move for Spring

§

impl RefUnwindSafe for Spring

§

impl Send for Spring

§

impl Sync for Spring

§

impl Unpin for Spring

§

impl UnsafeUnpin for Spring

§

impl UnwindSafe for Spring

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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> ErasedDestructor for T
where T: 'static,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoReactive<T, StaticMark> for T
where T: Clone + 'static,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.