Struct SpriteAnimator 

pub struct SpriteAnimator {
    pub clip: AnimationClip,
    pub current_frame: usize,
    pub elapsed: f32,
    pub playing: bool,
    pub finished: bool,
}

ECS component that drives sprite sheet animation.

Attach this to an entity alongside a Sprite to animate the sprite’s source_rect through a sequence of frames.

Example

use goud_engine::ecs::components::sprite_animator::{SpriteAnimator, AnimationClip};
use goud_engine::core::math::Rect;

let clip = AnimationClip::new(
    vec![Rect::new(0.0, 0.0, 32.0, 32.0), Rect::new(32.0, 0.0, 32.0, 32.0)],
    0.1,
);

let animator = SpriteAnimator::new(clip);
assert!(animator.playing);
assert!(!animator.finished);

Fields

clip: AnimationClip

The animation clip driving this animator.

current_frame: usize

Index of the current frame in clip.frames.

elapsed: f32

Accumulated time since the last frame advance.

playing: bool

Whether the animation is currently playing.

finished: bool

Whether a OneShot animation has completed.

Implementations

impl SpriteAnimator

pub fn new(clip: AnimationClip) -> SpriteAnimator

Creates a new animator from the given clip, starting playback immediately.

pub fn play(&mut self)

Starts (or restarts) playback from frame 0.

pub fn pause(&mut self)

Pauses playback without resetting frame position.

pub fn resume(&mut self)

Resumes playback from the current frame position.

pub fn reset(&mut self)

Resets the animator to its initial state (frame 0, not playing).

pub fn is_finished(&self) -> bool

Returns true if a OneShot animation has completed.

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

Returns the source Rect for the current frame, or None if the clip has no frames.

Trait Implementations

impl Clone for SpriteAnimator

fn clone(&self) -> SpriteAnimator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteAnimator

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpriteAnimator

fn deserialize<__D>( __deserializer: __D, ) -> Result<SpriteAnimator, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SpriteAnimator

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SpriteAnimator

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Component for SpriteAnimator

impl StructuralPartialEq for SpriteAnimator