Struct FrameAnimation 

pub struct FrameAnimation { /* private fields */ }

A playing frame animation: an explicit frame-order array stepped at a fixed fps.

Frame order[i] is displayed for t ∈ [i·d, (i+1)·d) where d = 1/fps; accumulating exactly one frame duration advances the cursor.

Implementations

impl FrameAnimation

pub fn new(order: impl Into<Vec<usize>>, fps: f32, loop_mode: LoopMode) -> Self

An animation playing order at fps. Starts at the first entry.

Panics

If order is empty or fps is not finite and positive — both are authoring errors, not runtime conditions.

pub fn start_at(self, position: usize) -> Self

Start at position within the order (clamped to the last entry) — For example, an animation may start at order position 1.

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

Advance by dt seconds. Returns true only on the tick where a LoopMode::Once animation finishes (a completion edge, once).

Large dt steps multiple frames; the leftover carries into the new frame so long-run timing never drifts. A nonpositive or non-finite dt is ignored. A LoopMode::Repeat tick whose frame duration is too small for f32 to subtract from the accumulated time drops the remainder.

pub fn current_frame(&self) -> usize

The sheet-frame index to display right now.

pub fn position(&self) -> usize

The cursor position within the order array.

pub fn is_finished(&self) -> bool

Whether a LoopMode::Once animation has played out.

pub fn reset(&mut self)

Rewind to the first order entry (restarts a finished animation).

Trait Implementations

impl Clone for FrameAnimation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameAnimation

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

Formats the value using the given formatter.