Skip to main content

Timeline

Struct Timeline 

Source
pub struct Timeline {
    pub name: String,
    pub fps: f32,
    /* private fields */
}
Expand description

Multi-track animation timeline.

Fields§

§name: String

Human-readable name for this timeline.

§fps: f32

Frames per second (used by frame_count).

Implementations§

Source§

impl Timeline

Source

pub fn new(name: impl Into<String>) -> Self

Create a new timeline with default fps of 24.

Source

pub fn with_fps(name: impl Into<String>, fps: f32) -> Self

Create a new timeline with an explicit fps value.

Source

pub fn add_track(&mut self, track: AnimTrack)

Add a track to the timeline.

Source

pub fn remove_track(&mut self, name: &str) -> bool

Remove the track named name. Returns true if a track was removed.

Source

pub fn get_track(&self, name: &str) -> Option<&AnimTrack>

Get an immutable reference to the named track.

Source

pub fn get_track_mut(&mut self, name: &str) -> Option<&mut AnimTrack>

Get a mutable reference to the named track.

Source

pub fn track_names(&self) -> Vec<&str>

Sorted list of all track names.

Source

pub fn track_count(&self) -> usize

Number of tracks in this timeline.

Source

pub fn duration(&self) -> f32

Maximum duration across all tracks.

Source

pub fn frame_count(&self) -> usize

Number of frames: ceil(duration * fps).

Source

pub fn evaluate(&self, time: f32) -> HashMap<String, f32>

Evaluate all tracks at time, returning a map of track name to value.

Source

pub fn bake(&self, sample_fps: f32) -> Vec<HashMap<String, f32>>

Sample the timeline at uniform intervals of 1.0 / sample_fps from t = 0 to the timeline duration, returning a Vec of name→value snapshots.

Source

pub fn set_key(&mut self, track_name: &str, time: f32, value: f32)

Add a keyframe to the named track, creating it (with Linear interp) if absent.

Source

pub fn time_offset(&mut self, dt: f32)

Shift all keyframes in every track by dt seconds.

Source

pub fn time_scale(&mut self, factor: f32)

Scale all keyframe times by factor (speed up or slow down the timeline).

Trait Implementations§

Source§

impl Default for Timeline

Source§

fn default() -> Self

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

Auto Trait Implementations§

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.