Skip to main content

AnimationTrack

Struct AnimationTrack 

Source
pub struct AnimationTrack<T: Lerp> { /* private fields */ }
Expand description

A sorted collection of keyframes with interpolated value_at(t) lookup.

Keyframes are kept in ascending timestamp order at all times. The easing used for each interval is taken from the preceding keyframe’s easing field; the last keyframe’s easing is never read.

§Panics

value_at panics if the track is empty. Always push at least one keyframe before querying.

Implementations§

Source§

impl<T: Lerp> AnimationTrack<T>

Source

pub fn new() -> Self

Creates an empty track.

Source

pub fn push(self, kf: Keyframe<T>) -> Self

Inserts a keyframe, maintaining timestamp-sorted order.

If a keyframe at the same timestamp already exists it is replaced.

Source

pub fn value_at(&self, t: Duration) -> T

Returns the interpolated value at time t.

  • Before the first keyframe: returns the first value (hold).
  • After the last keyframe: returns the last value (hold).
  • Between two keyframes: uses the preceding keyframe’s easing.
§Panics

Panics if the track is empty.

Source

pub fn keyframes(&self) -> &[Keyframe<T>]

Returns all keyframes in sorted (ascending-timestamp) order.

Source

pub fn len(&self) -> usize

Returns the number of keyframes in the track.

Source

pub fn is_empty(&self) -> bool

Returns true if the track has no keyframes.

Source§

impl AnimationTrack<f64>

Source

pub fn fade( from: f64, to: f64, start: Duration, end: Duration, easing: Easing, ) -> Self

Creates a two-keyframe track that ramps linearly (or with easing) from from to to between start and end.

  • Before start: value is held at from.
  • Between start and end: value is interpolated using easing.
  • After end: value is held at to.

This is the common-case shorthand for a volume fade, opacity ramp, or position sweep. Equivalent to:

AnimationTrack::new()
    .push(Keyframe::new(Duration::ZERO, 0.0_f64, Easing::Linear))
    .push(Keyframe::new(Duration::from_secs(2), 1.0_f64, Easing::Linear));

Trait Implementations§

Source§

impl<T: Clone + Lerp> Clone for AnimationTrack<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Lerp> Debug for AnimationTrack<T>

Source§

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

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

impl<T: Lerp> Default for AnimationTrack<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for AnimationTrack<T>

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for AnimationTrack<T>

§

impl<T> UnwindSafe for AnimationTrack<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.