Skip to main content

MotionBinding

Struct MotionBinding 

Source
pub struct MotionBinding<S, T>
where T: Animatable,
{ /* private fields */ }
Expand description

Reusable configuration that maps business states to motion targets.

A binding contains no mutable playback state. Call MotionBinding::state once per consumer, then pass that state to MotionBinding::set_state. Exact (from, to) factories take precedence over the fallback factory.

§Examples

use aura_anim_core::{MotionBinding, MotionRuntime, timing::{Duration, Timing}};

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum ButtonState {
    Idle,
    Hovered,
}

let binding = MotionBinding::new(ButtonState::Idle, 0.8_f32)
    .when(ButtonState::Hovered, 1.0)
    .transition(ButtonState::Idle, ButtonState::Hovered, |context| {
        context.tween(Timing::ease_out(120.0))
    })
    .fallback(|context| context.tween(Timing::linear(100.0)));

let mut runtime = MotionRuntime::new();
let (motion, mut state) = binding.create_motion(&mut runtime);
let playback = binding
    .set_state_tracked(
        &mut state,
        ButtonState::Hovered,
        motion,
        &mut runtime,
    )
    .unwrap()
    .unwrap();
runtime.tick(Duration::from_millis(120.0));

assert_eq!(motion.value(&runtime).unwrap(), 1.0);
assert!(runtime.take_events()[0].is_completed_for(playback));

Implementations§

Source§

impl<S, T> MotionBinding<S, T>
where S: Clone + PartialEq + 'static, T: Animatable,

Source

pub fn new(initial_state: S, initial_target: T) -> MotionBinding<S, T>

Creates a binding with its initial business state and target value.

Source

pub fn when(self, state: S, target: T) -> MotionBinding<S, T>

Adds or replaces the target associated with state.

Source

pub fn transition<A>( self, from: S, to: S, factory: impl Fn(TransitionContext<S, T>) -> A + 'static, ) -> MotionBinding<S, T>
where A: Animation<T>,

Adds or replaces an exact (from, to) transition factory.

The factory may return any concrete Animation; the binding handles type erasure internally.

Source

pub fn fallback<A>( self, factory: impl Fn(TransitionContext<S, T>) -> A + 'static, ) -> MotionBinding<S, T>
where A: Animation<T>,

Sets the factory used when no exact transition is configured.

The factory may return any concrete Animation; the binding handles type erasure internally.

Source

pub const fn initial_state(&self) -> &S

Returns the initial business state.

Source

pub fn target(&self, state: &S) -> Result<&T, MotionBindingError<S>>

Returns the target associated with state.

Source

pub fn state(&self) -> MotionBindingState<S>

Creates independent state tracking for one consumer.

Source

pub fn create_motion( &self, runtime: &mut MotionRuntime, ) -> (Motion<T>, MotionBindingState<S>)

Creates a motion at the initial target and its independent state tracker.

Source

pub fn set_state( &self, binding_state: &mut MotionBindingState<S>, next_state: S, motion: Motion<T>, runtime: &mut MotionRuntime, ) -> Result<bool, MotionBindingError<S>>

Applies next_state to an existing motion.

Returns Ok(false) when the requested state is already current. Use MotionBinding::set_state_tracked when the concrete playback ID is needed for event matching.

Source

pub fn set_state_tracked( &self, binding_state: &mut MotionBindingState<S>, next_state: S, motion: Motion<T>, runtime: &mut MotionRuntime, ) -> Result<Option<PlaybackId>, MotionBindingError<S>>

Applies next_state and returns the concrete playback ID.

Returns Ok(None) when the requested state is already current. Target and transition lookup happen before the motion is modified. The state tracker is updated only after motion.play_tracked succeeds.

Trait Implementations§

Source§

impl<S, T> Clone for MotionBinding<S, T>
where S: Clone, T: Clone + Animatable,

Source§

fn clone(&self) -> MotionBinding<S, T>

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

Auto Trait Implementations§

§

impl<S, T> !RefUnwindSafe for MotionBinding<S, T>

§

impl<S, T> !Send for MotionBinding<S, T>

§

impl<S, T> !Sync for MotionBinding<S, T>

§

impl<S, T> !UnwindSafe for MotionBinding<S, T>

§

impl<S, T> Freeze for MotionBinding<S, T>
where S: Freeze, T: Freeze,

§

impl<S, T> Unpin for MotionBinding<S, T>
where S: Unpin, T: Unpin,

§

impl<S, T> UnsafeUnpin for MotionBinding<S, T>
where S: UnsafeUnpin, T: UnsafeUnpin,

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> 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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = 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