Struct Animator 

pub struct Animator {
    pub current_animation: Option<SpriteAnimation>,
    pub current_frame_index: usize,
    pub elapsed_time: f64,
    pub state: AnimationState,
    pub direction: i32,
    pub flip_y: bool,
    /* private fields */
}

Manages the playback state of sprite animations.

Fields

current_animation: Option<SpriteAnimation>

The currently active animation, if any.

get_current_animation is public: engine/tests/animator inspects the active clip from outside this crate. get_mut / set stay crate-internal — clip changes go through the playback API.

current_frame_index: usize

The index of the current frame being displayed.

elapsed_time: f64

The elapsed time within the current frame, in seconds.

state: AnimationState

The current playback state.

direction: i32

The direction of playback (1 = forward, -1 = backward) for ping-pong mode.

flip_y: bool

Whether to flip the sprite vertically when rendering.

Implementations

impl Animator

Implements playback control for Animator.

pub fn create() -> Animator

Creates a new idle animator with no animation.

Returns

• Animator - The new animator.

pub fn play(&mut self, animation: SpriteAnimation)

Plays the given animation from the beginning.

Arguments

• SpriteAnimation - The animation to play.

pub fn pause(&mut self)

Pauses the current animation.

pub fn resume(&mut self)

Resumes the current animation from where it was paused.

pub fn stop(&mut self)

Stops the current animation and resets to the first frame.

pub fn update(&mut self, delta_time: f64)

Advances the animation by the given delta time.

Arguments

• f64 - The time elapsed since the last update, in seconds.

pub fn current_frame_source(&self) -> Option<Rect>

Returns the source rectangle of the current frame, or None if no animation is playing.

Returns

• Option<Rect> - The current frame’s source rectangle.

impl Animator

Implements animated sprite rendering for Animator.

pub fn draw( &self, context: &CanvasRenderingContext2d, sheet: &SpriteSheet, transform: &Transform2D, )

Draws the current frame of this animator onto the canvas.

Arguments

• &CanvasRenderingContext2d - The canvas context.
• &SpriteSheet - The sprite sheet containing the image.
• &Transform2D - The world-space transform to apply.

impl Animator

pub fn get_current_animation(&self) -> Option<SpriteAnimation>

pub fn try_get_current_animation(&self) -> Option<SpriteAnimation>

pub fn get_current_frame_index(&self) -> usize

pub fn get_elapsed_time(&self) -> f64

pub fn get_state(&self) -> AnimationState

pub fn get_direction(&self) -> i32

pub fn get_flip_y(&self) -> bool

impl Animator

pub fn new(state: AnimationState, direction: i32) -> Self

Trait Implementations

impl Clone for Animator

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 Animator

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

Formats the value using the given formatter.

impl Default for Animator

Implements Default for Animator as a new idle animator.

fn default() -> Animator

Constructs a default Animator value.

Returns

• Animator - A default-constructed instance with the documented initial state.

impl PartialEq for Animator

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Animator

impl Updatable for Animator

Forwards Animator::update through the Updatable trait so that collections of heterogeneous updateable objects (entities, animators, physics worlds, scene managers) can be driven by a single scheduler loop.

The inherent Animator::update method is the canonical implementation; this impl exists purely for trait dispatch. The inherent call resolves first when both are in scope, so there is no recursion.

fn update(&mut self, delta_time: f64)

Advances the simulation by delta_time seconds.

Arguments

• f64 - Seconds elapsed since the previous update.