Skip to main content

AnimationPlayer

Struct AnimationPlayer 

Source
pub struct AnimationPlayer { /* private fields */ }
Expand description

CPU playback cursor. Drawing/reading a frame never changes playback. Advancement uses integer nanoseconds and binary frame lookup, so large time steps do not iterate over every crossed frame or loop.

Implementations§

Source§

impl AnimationPlayer

Source

pub fn new(clip: impl Into<Arc<AnimationClip>>) -> Self

Starts at the first frame, unpaused. Accepts an owned clip or shared Arc.

Source

pub fn play(&mut self, clip: impl Into<Arc<AnimationClip>>)

Switches/restarts a clip, clearing pause and completion state.

Source

pub fn reset(&mut self)

Rewinds this clip and rearms its completion event, preserving pause state.

Source

pub fn pause(&mut self)

Stops advancement without changing the current frame.

Source

pub fn resume(&mut self)

Allows advancement again. A completed one-shot remains completed until reset/play.

Source

pub fn is_paused(&self) -> bool

Whether explicit time advancement is paused.

Source

pub fn is_finished(&self) -> bool

Whether a one-shot has reached its end.

Source

pub fn clip(&self) -> &Arc<AnimationClip> ⓘ

Current immutable clip.

Source

pub fn elapsed(&self) -> Duration

Time within this traversal, clamped to duration for a finished one-shot.

Source

pub fn frame_index(&self) -> usize

Current frame index. Exact boundaries select the next frame; a completed one-shot holds the last frame for drawing.

Source

pub fn frame(&self) -> &SpriteFrame

Current frame, without advancing simulation.

Source

pub fn advance(&mut self, dt: Duration) -> Option<AnimationCompleted>

Advances by explicitly supplied simulation time. Zero time, paused or completed playback does nothing. Looping wraps including exact boundaries; a one-shot discards excess time and returns one completion on its first end. No allocation occurs, including at completion (the clip’s Arc is cloned).

Trait Implementations§

Source§

impl Clone for AnimationPlayer

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnimationPlayer

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Component for T
where T: Send + Sync + 'static,

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.