Skip to main content

MotionRuntime

Struct MotionRuntime 

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

Stores animations, advances active values, and queues lifecycle events.

§Examples

use aura_anim_core::{MotionRuntime, timing::Timing};
use std::time::Duration;

let mut runtime = MotionRuntime::new();
let opacity = runtime.motion_with(0.0_f32, Timing::new(100.0));

opacity.transition_to(1.0, &mut runtime).unwrap();
runtime.tick(Duration::from_millis(50));

assert_eq!(opacity.value(&runtime).unwrap(), 0.5);
assert!(opacity.is_active(&runtime).unwrap());
assert!(runtime.events().is_empty());

Implementations§

Source§

impl MotionRuntime

Source

pub fn new() -> MotionRuntime

Creates an empty motion runtime.

Source

pub fn motion<T>(&mut self, initial: T) -> Motion<T>
where T: Animatable,

Inserts an idle motion with the default transition timing.

Source

pub fn motion_with<T>(&mut self, initial: T, timing: Timing) -> Motion<T>
where T: Animatable,

Inserts an idle motion with the provided transition timing.

Source

pub fn insert<T>( &mut self, animation: impl Animation<T>, transition: Timing, ) -> Motion<T>
where T: Animatable,

Inserts an animation that remains stored after it settles.

Source

pub fn play_once<T>(&mut self, animation: impl Animation<T>) -> Motion<T>
where T: Animatable,

Inserts an animation that is removed after it settles.

Source

pub fn insert_with_policy<T>( &mut self, animation: impl Animation<T>, transition: Timing, retain_policy: RetainPolicy, ) -> Motion<T>
where T: Animatable,

Inserts an animation with transition timing and a retention policy.

Source

pub fn tick(&mut self, delta: impl Into<Duration>)

Advances every active animation by delta.

Source

pub fn tick_at(&mut self, now: Instant)

Advances active animations using elapsed wall-clock time.

The first call establishes the clock origin and advances by zero.

Source

pub fn events(&self) -> &[MotionEvent]

Returns queued lifecycle events without consuming them.

Source

pub fn take_events(&mut self) -> Vec<MotionEvent>

Takes all queued lifecycle events.

Events remain queued until they are taken or explicitly cleared.

Source

pub fn clear_events(&mut self)

Removes all queued lifecycle events.

Source

pub fn pending_event_count(&self) -> usize

Returns the number of queued lifecycle events.

Source

pub fn active_count(&self) -> usize

Returns the number of animations currently marked active.

Source

pub fn has_active(&self) -> bool

Returns whether at least one animation is active.

Source

pub fn motion_count(&self) -> usize

Returns the number of stored animations.

Source

pub fn slot_capacity(&self) -> usize

Returns the allocated capacity of the runtime slot storage.

Source

pub fn shrink_to_fit(&mut self)

Releases unused slot and queue capacity.

Source

pub fn value<T>(&self, motion: Motion<T>) -> Result<&T, MotionError>
where T: Animatable,

Returns the current value for motion.

Source

pub fn state<T>(&self, motion: Motion<T>) -> Result<AnimationState, MotionError>
where T: Animatable,

Returns the lifecycle state for motion.

Source

pub fn playback<T>(&self, motion: Motion<T>) -> Result<PlaybackId, MotionError>
where T: Animatable,

Returns the ID of the motion’s current playback.

Source

pub fn is_active<T>(&self, motion: Motion<T>) -> Result<bool, MotionError>
where T: Animatable,

Returns whether motion is active.

Source

pub fn transition_to<T>( &mut self, motion: Motion<T>, target: T, ) -> Result<(), MotionError>
where T: Animatable,

Transitions motion toward target.

Source

pub fn transition_to_tracked<T>( &mut self, motion: Motion<T>, target: T, ) -> Result<PlaybackId, MotionError>
where T: Animatable,

Transitions motion toward target and returns its new playback ID.

Source

pub fn play<T, P, Kind>( &mut self, motion: Motion<T>, playback: P, ) -> Result<(), MotionError>
where T: Animatable, P: IntoMotionAnimation<T, Kind>,

Replaces the animation associated with motion.

Source

pub fn play_tracked<T, P, Kind>( &mut self, motion: Motion<T>, playback: P, ) -> Result<PlaybackId, MotionError>
where T: Animatable, P: IntoMotionAnimation<T, Kind>,

Replaces the animation associated with motion and returns its playback ID.

Source

pub fn command<T>( &mut self, motion: Motion<T>, command: AnimationCommand, ) -> Result<(), MotionError>
where T: Animatable,

Applies a command to motion.

Source

pub fn command_all(&mut self, command: AnimationCommand)

Applies command to every stored motion.

This includes idle, running, paused, and settled motions. Commands keep their normal per-animation semantics, including terminal events and RetainPolicy::DropWhenSettled removal.

Source

pub fn remove<T>(&mut self, motion: Motion<T>) -> Result<(), MotionError>
where T: Animatable,

Removes the animation referenced by motion.

Trait Implementations§

Source§

impl Default for MotionRuntime

Source§

fn default() -> MotionRuntime

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more