Struct KeyframeTrack 

pub struct KeyframeTrack<T>
where
    T: Tweenable,
{ /* private fields */ }

A track containing keyframes that can be sampled at any time.

Type Parameters

• T: The value type, must implement Tweenable.

Examples

use eazy_keyframes::{KeyframeTrack, Keyframe};
use eazy_core::Easing;

let track = KeyframeTrack::new()
  .keyframe(0.0, 0.0_f32)
  .keyframe_eased(0.5, 100.0, Easing::OutBounce)
  .keyframe(1.0, 50.0);

let value = track.sample(0.25);

Implementations

impl<T> KeyframeTrack<T>

where T: Tweenable,

pub fn new() -> KeyframeTrack<T>

Create a new empty keyframe track.

pub fn with_default_easing(easing: Easing) -> KeyframeTrack<T>

Create a track with a specific default easing.

pub fn add(&mut self, keyframe: Keyframe<T>)

Add a keyframe to the track.

pub fn keyframe(self, time: f32, value: T) -> KeyframeTrack<T>

Add a keyframe (builder pattern).

pub fn keyframe_eased( self, time: f32, value: T, easing: Easing, ) -> KeyframeTrack<T>

Add a keyframe with easing (builder pattern).

pub fn len(&self) -> usize

Get the number of keyframes.

pub fn is_empty(&self) -> bool

Check if the track is empty.

pub fn duration(&self) -> f32

Get the duration of the track (time of last keyframe).

pub fn start_time(&self) -> f32

Get the start time (time of first keyframe).

pub fn get(&self, index: usize) -> Option<&Keyframe<T>>

Get a keyframe by index.

pub fn sample(&self, time: f32) -> T

Sample the track at a given time.

Returns the interpolated value between keyframes. Times before the first keyframe return the first value. Times after the last keyframe return the last value.

pub fn sample_clamped(&self, time: f32) -> T

Sample with clamping to track bounds.

pub fn iter(&self) -> impl Iterator<Item = &Keyframe<T>>

Iterate over keyframes.

Trait Implementations

impl<T> Clone for KeyframeTrack<T>

where T: Clone + Tweenable,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for KeyframeTrack<T>

where T: Debug + Tweenable,

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

Formats the value using the given formatter.

impl<T> Default for KeyframeTrack<T>

where T: Tweenable,

fn default() -> KeyframeTrack<T>

Returns the “default value” for a type.

impl<T> From<Vec<Keyframe<T>>> for KeyframeTrack<T>

where T: Tweenable,

fn from(keyframes: Vec<Keyframe<T>>) -> KeyframeTrack<T>

Converts to this type from the input type.

impl<T> FromIterator<Keyframe<T>> for KeyframeTrack<T>

where T: Tweenable,

fn from_iter<I>(iter: I) -> KeyframeTrack<T>

where I: IntoIterator<Item = Keyframe<T>>,

Creates a value from an iterator.