Skip to main content

Spring

Struct Spring 

Source
pub struct Spring<T: Animatable> { /* private fields */ }
Expand description

An animation driven by a damped spring simulation.

Implementations§

Source§

impl<T: Animatable> Spring<T>

Source

pub fn new(from: T, to: T, config: SpringConfig) -> Self

Creates a running spring animation from from to to.

Source

pub fn retarget(&mut self, target: T)

Restarts the spring from its current value toward target.

Trait Implementations§

Source§

impl<T: Animatable> Animation<T> for Spring<T>

Source§

fn value(&self) -> &T

Returns the animation’s current value.
Source§

fn state(&self) -> AnimationState

Returns the animation’s lifecycle state.
Source§

fn tick(&mut self, delta: Duration)

Advances the animation by delta.
Source§

fn pause(&mut self)

Pauses a running animation.
Source§

fn resume(&mut self)

Resumes a paused animation.
Source§

fn cancel(&mut self)

Cancels the animation.
Source§

fn seek(&mut self, progress: f32)

Seeks to normalized progress within the animation.
Source§

fn finish(&mut self)

Moves the animation to its completed state.
Source§

fn retarget(&mut self, target: &T) -> bool

Attempts to continue the animation toward a new target. Read more
Source§

fn duration(&self) -> Option<Duration>

Returns the total duration when it is finite and known.
Source§

fn advance(&mut self, delta: Duration) -> Duration

Advances the animation and returns any unconsumed duration.
Source§

fn is_active(&self) -> bool

Returns whether the animation is currently running.
Source§

impl<T: Clone + Animatable> Clone for Spring<T>

Source§

fn clone(&self) -> Spring<T>

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<T: Debug + Animatable> Debug for Spring<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Spring<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Spring<T>
where T: RefUnwindSafe,

§

impl<T> Send for Spring<T>
where T: Send,

§

impl<T> Sync for Spring<T>
where T: Sync,

§

impl<T> Unpin for Spring<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Spring<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Spring<T>
where T: UnwindSafe,

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.