Struct Timeline 

pub struct Timeline {
    pub looping: Loop,
    pub time_scale: f32,
    /* private fields */
}

Composes multiple animations on one shared clock.

Entries are stored by label, absolute start time, and cached duration. Normal one-shot playback advances children incrementally. Seeking and timeline-level loops resynchronize children through Playable::seek_to.

Fields

looping: Loop

Timeline-level looping behavior.

time_scale: f32

Timeline time scale. 1.0 = normal speed, 2.0 = double speed.

Implementations

impl Timeline

pub fn new() -> Timeline

Create an empty timeline.

pub fn add<A>( self, label: impl Into<String>, animation: A, at: At<'_>, ) -> Timeline

where A: Playable + Send + 'static,

Add an animation at the requested position.

Missing At::Label references fall back to At::End behavior.

pub fn looping(self, mode: Loop) -> Timeline

Set timeline-level looping behavior.

pub fn time_scale(self, scale: f32) -> Timeline

Set the timeline time scale.

Negative values are clamped to 0.0.

pub fn set_time_scale(&mut self, scale: f32)

Change the timeline time scale at runtime.

1.0 is normal speed, 2.0 is double speed, and 0.0 freezes time.

pub fn on_entry_complete( self, label: impl Into<String>, f: impl FnMut() + Send + 'static, ) -> Timeline

Register a callback fired when the labeled entry completes during update.

This is available with the std feature. Seeking and resetting do not fire callbacks.

pub fn on_complete(self, f: impl FnMut() + Send + 'static) -> Timeline

Register a callback fired once when finite timeline playback completes during update.

This is available with the std feature. Seeking to the end does not fire this callback.

pub fn play(&mut self)

Begin playback.

pub fn pause(&mut self)

Pause playback.

pub fn resume(&mut self)

Resume playback after a pause.

pub fn reset(&mut self)

Reset the timeline and all children to the beginning.

pub fn seek(&mut self, progress: f32)

Seek by normalized progress through the timeline.

pub fn seek_abs(&mut self, secs: f32)

Seek to an absolute time in seconds.

pub fn duration(&self) -> f32

Base duration in seconds, equal to the last finishing entry.

pub fn progress(&self) -> f32

Current normalized progress through finite playback.

pub fn is_complete(&self) -> bool

true when the timeline has finished all finite playback.

pub fn state(&self) -> TimelineState

Current timeline state.

pub fn elapsed(&self) -> f32

Current total elapsed timeline time in seconds.

pub fn entry_count(&self) -> usize

Number of entries in the timeline.

pub fn get<T>(&self, label: &str) -> Option<&T>

where T: Playable + 'static,

Find a child animation by label and concrete type.

pub fn get_mut<T>(&mut self, label: &str) -> Option<&mut T>

where T: Playable + 'static,

Find a mutable child animation by label and concrete type.

Trait Implementations

impl Debug for Timeline

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

Formats the value using the given formatter.

impl Default for Timeline

fn default() -> Timeline

Returns the “default value” for a type.

impl Playable for Timeline

fn duration(&self) -> f32

Total finite duration in seconds.

fn reset(&mut self)

Reset the animation to its initial state.

fn seek_to(&mut self, progress: f32)

Seek to normalized progress through the animation.

fn is_complete(&self) -> bool

true when the animation has reached its terminal state.

fn as_any(&self) -> &(dyn Any + 'static)

Return a type-erased shared reference for downcasting.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Return a type-erased mutable reference for downcasting.

impl Update for Timeline

fn update(&mut self, dt: f32) -> bool

Advance the animation by dt seconds.