Struct Animation

pub struct Animation<T>
where
    T: Clone + Copy + PartialEq + Float,
{ /* private fields */ }

The animation of some particular state.

It tracks state changes and allows projecting interpolated values through time.

Implementations

impl<T> Animation<T>

where T: Clone + Copy + PartialEq + Float,

pub fn new(state: T) -> Self

Creates a new Animation with the given initial state.

pub fn easing(self, easing: Easing) -> Self

Sets the Easing function of the Animation.

See the Easing Functions Cheat Sheet for details!

pub fn very_quick(self) -> Self

Sets the duration of the Animation to 100ms.

pub fn quick(self) -> Self

Sets the duration of the Animation to 200ms.

pub fn slow(self) -> Self

Sets the duration of the Animation to 400ms.

pub fn very_slow(self) -> Self

Sets the duration of the Animation to 500ms.

pub fn duration(self, duration: Duration) -> Self

Sets the duration of the Animation to the given value.

pub fn delay(self, duration: Duration) -> Self

Sets a delay for the Animation.

pub fn repeat(self, repetitions: u32) -> Self

Makes the Animation repeat a given amount of times.

Providing 1 repetition plays the animation twice in total.

pub fn repeat_forever(self) -> Self

Makes the Animation repeat forever.

pub fn auto_reverse(self) -> Self

Makes the Animation automatically reverse when repeating.

pub fn go(self, new_state: T, at: Instant) -> Self

Transitions the Animation from its current state to the given new state at the given time.

pub fn go_mut(&mut self, new_state: T, at: Instant)

Transitions the Animation from its current state to the given new state at the given time, by reference.

pub fn is_animating(&self, at: Instant) -> bool

Returns true if the Animation is currently in progress.

An Animation is in progress when it is transitioning to a different state.

pub fn interpolate_with<I>(&self, f: impl Fn(T) -> I, at: Instant) -> I

where I: Interpolable,

Projects the Animation into an interpolated value at the given Instant; using the closure provided to calculate the different keyframes of interpolated values.

If the Animation state is a bool, you can use the simpler interpolate method.

pub fn value(&self) -> T

Retuns the current state of the Animation.

impl Animation<bool>

pub fn interpolate<I>(&self, start: I, end: I, at: Instant) -> I

where I: Interpolable + Clone,

Projects the Animation into an interpolated value at the given Instant; using the start and end values as the origin and destination keyframes.

pub fn remaining(&self, at: Instant) -> Duration

Returns the remaining Duration of the Animation.

Trait Implementations

impl<T> Clone for Animation<T>

where T: Clone + Copy + PartialEq + Float + Clone,

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

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Animation<T>

where T: Clone + Copy + PartialEq + Float + Debug,

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

Formats the value using the given formatter.