Struct keyframe::Keyframe

pub struct Keyframe<T> { /* private fields */ }

Intermediate step in an animation sequence

Implementations

impl<T> Keyframe<T>

pub fn new<F: Float>(
    value: T,
    time: F,
    function: impl EasingFunction + 'static + Send + Sync
) -> Self

Creates a new keyframe from the specified values. If the time value is negative the keyframe will start at 0.0.

Arguments

• value - The value that this keyframe will be tweened to/from
• time - The start time in seconds of this keyframe
• function - The easing function to use from the start of this keyframe to the start of the next keyframe

pub fn new_dynamic<F: Float>(
    value: T,
    time: F,
    function: Box<dyn EasingFunction + Send + Sync + 'static>
) -> Self

Same as new, but allows you to supply an easing function which size is not known at compile time.

Arguments

• value - The value that this keyframe will be tweened to/from
• time - The start time in seconds of this keyframe
• function - The easing function to use from the start of this keyframe to the start of the next keyframe

pub fn value(&self) -> T where
    T: Clone, 

The value of this keyframe

pub fn time(&self) -> f64

The time in seconds at which this keyframe starts in a sequence

pub fn function(&self) -> &dyn EasingFunction

The easing function that will be used when tweening to another keyframe

pub fn tween_to(&self, next: &Keyframe<T>, time: impl Float) -> T where
    T: CanTween + Clone, 

Returns the value between this keyframe and the next keyframe at the specified time

Note

The following applies if:

• The requested time is before the start time of this keyframe: the value of this keyframe is returned
• The requested time is after the start time of next keyframe: the value of the next keyframe is returned
• The start time of the next keyframe is before the start time of this keyframe: the value of the next keyframe is returned

Trait Implementations

impl<T: Clone> Clone for Keyframe<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Keyframe<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Keyframe<T>

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

Formats the value using the given formatter.

impl<V, T: Float> From<(V, T, Box<dyn EasingFunction + Send + Sync + 'static, Global>)> for Keyframe<V>

fn from(tuple: (V, T, Box<dyn EasingFunction + Send + Sync + 'static>)) -> Self

Creates a new keyframe from a tuple of (value, time, function). If the time value is negative the keyframe will start at 0.0.

impl<V, T: Float, F: EasingFunction + 'static + Send + Sync> From<(V, T, F)> for Keyframe<V>

fn from(tuple: (V, T, F)) -> Self

Creates a new keyframe from a tuple of (value, time, function). If the time value is negative the keyframe will start at 0.0.

impl<V, T: Float> From<(V, T)> for Keyframe<V>

fn from(tuple: (V, T)) -> Self

Creates a new keyframe from a tuple of (value, time). EaseInOut will be used as the easing function. If the time value is negative the keyframe will start at 0.0.