Struct AnimationRuntime 

pub struct AnimationRuntime<C = SystemClock> { /* private fields */ }

Runtime state owned by an Iced application.

Example

use aura_anim_iced::{
    AnimationRuntime, AnimationTargetId, KeyframesBuilder, Timing, property,
};

let mut runtime = AnimationRuntime::new();
let target = AnimationTargetId::new();

let registration = runtime.register_keyframes(
    target,
    KeyframesBuilder::new()
        .with_timing(Timing::new(100.0))
        .at(0.0, (property::OPACITY, 0.0))
        .at(1.0, (property::OPACITY, 1.0))
        .finish(),
);

assert!(runtime.should_subscribe());

Implementations

impl AnimationRuntime<SystemClock>

pub fn new() -> Self

Creates an empty runtime using a monotonic system clock.

impl AnimationRuntime<TestClock>

pub fn testing() -> Self

Creates an empty runtime with a deterministic test clock at zero.

pub const fn clock_mut(&mut self) -> &mut TestClock

Returns mutable access to the runtime clock.

This is primarily useful for deterministic tests and custom clock integrations.

impl<C: AnimationClock> AnimationRuntime<C>

pub fn with_clock(clock: C) -> Self

Creates an empty runtime with a custom clock.

pub fn register_keyframes( &mut self, target: AnimationTargetId, keyframes: Keyframes, ) -> AnimationRegistration

Registers keyframes and returns their initial runtime output.

pub fn register_timeline( &mut self, target: AnimationTargetId, timeline: Timeline, ) -> AnimationRegistration

Registers a timeline and returns its initial runtime output.

pub fn tick(&mut self) -> AnimationTick

Advances active animations and returns a view-ready aggregated snapshot.

pub fn tick_into(&mut self, output: &mut AnimationTick)

Advances active animations into a reusable tick output.

pub fn cancel_target(&mut self, target: AnimationTargetId)

Cancels and removes all active animations registered for target.

pub fn seek_target(&mut self, target: AnimationTargetId, pos: Duration)

Seeks all active animations registered for target.

pub fn pause_target(&mut self, target: AnimationTargetId)

Pauses all active animations registered for target.

pub fn cancel( &mut self, target: AnimationTargetId, handle: AnimationHandle, ) -> bool

Cancels and removes one animation when handle belongs to target.

Returns true when an entry was removed.

pub fn seek( &mut self, target: AnimationTargetId, handle: AnimationHandle, pos: Duration, ) -> bool

Seeks one animation when handle belongs to target.

Returns true when an entry was found and updated.

pub fn pause( &mut self, target: AnimationTargetId, handle: AnimationHandle, ) -> bool

Pauses one animation when handle belongs to target.

Returns true when an entry was found and updated.

impl<C> AnimationRuntime<C>

pub const fn clock(&self) -> &C

Returns the runtime clock.

pub const fn motion_policy(&self) -> TickPolicy

Returns the current motion policy.

pub const fn set_motion_policy(&mut self, motion_policy: TickPolicy)

Replaces the current motion policy.

pub fn active_count(&self) -> usize

Returns the number of active animation entries.

pub fn is_idle(&self) -> bool

Returns whether the runtime has no active animation entries.

pub fn should_tick(&self) -> bool

Returns whether the runtime has entries that should receive animation ticks.

pub fn should_subscribe(&self) -> bool

Returns whether an Iced subscription should keep producing animation ticks.

Trait Implementations

impl<C: Clone> Clone for AnimationRuntime<C>

fn clone(&self) -> AnimationRuntime<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for AnimationRuntime<C>

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

Formats the value using the given formatter.

impl Default for AnimationRuntime<SystemClock>

fn default() -> Self

Returns the “default value” for a type.