Struct Motion 

pub struct Motion<T> { /* private fields */ }

A typed handle to an animation stored in a MotionRuntime.

Handles become invalid after their animation is removed.

Implementations

impl<T> Motion<T>

pub const fn motion_id(self) -> MotionId

Returns the untyped ID for this motion lifecycle.

impl<T> Motion<T>

where T: Animatable,

pub fn transition_to( self, target: T, runtime: &mut MotionRuntime, ) -> Result<(), MotionError>

Transitions this motion toward target.

pub fn transition_to_tracked( self, target: T, runtime: &mut MotionRuntime, ) -> Result<PlaybackId, MotionError>

Transitions this motion and returns the new playback ID.

pub fn play<P, Kind>( self, playback: P, runtime: &mut MotionRuntime, ) -> Result<(), MotionError>

where P: IntoMotionAnimation<T, Kind>,

Replaces this motion’s current animation.

pub fn play_tracked<P, Kind>( self, playback: P, runtime: &mut MotionRuntime, ) -> Result<PlaybackId, MotionError>

where P: IntoMotionAnimation<T, Kind>,

Replaces this motion’s current animation and returns its playback ID.

pub fn value(self, runtime: &MotionRuntime) -> Result<T, MotionError>

Clones and returns the current value.

pub fn value_ref(self, runtime: &MotionRuntime) -> Result<&T, MotionError>

Borrows the current value.

pub fn state( self, runtime: &MotionRuntime, ) -> Result<AnimationState, MotionError>

Returns the current lifecycle state.

pub fn playback( self, runtime: &MotionRuntime, ) -> Result<PlaybackId, MotionError>

Returns the ID of this motion’s current playback.

pub fn is_active(self, runtime: &MotionRuntime) -> Result<bool, MotionError>

Returns whether the motion is active.

pub fn is_completed(self, runtime: &MotionRuntime) -> Result<bool, MotionError>

Returns whether the motion completed.

pub fn pause(self, runtime: &mut MotionRuntime) -> Result<(), MotionError>

Pauses the motion.

pub fn resume(self, runtime: &mut MotionRuntime) -> Result<(), MotionError>

Resumes the motion.

pub fn cancel(self, runtime: &mut MotionRuntime) -> Result<(), MotionError>

Cancels the motion.

pub fn seek( self, progress: f32, runtime: &mut MotionRuntime, ) -> Result<(), MotionError>

Seeks the motion to normalized progress.

pub fn finish(self, runtime: &mut MotionRuntime) -> Result<(), MotionError>

Moves the motion to completion.

pub fn remove(self, runtime: &mut MotionRuntime) -> Result<(), MotionError>

Removes the motion from the runtime.

Trait Implementations

impl<T> Clone for Motion<T>

fn clone(&self) -> Motion<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Copy for Motion<T>

impl<T> Debug for Motion<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Eq for Motion<T>

where T: Eq,

impl<T> Hash for Motion<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> MotionEventTarget for Motion<T>

impl<T> PartialEq for Motion<T>

where T: PartialEq,

fn eq(&self, other: &Motion<T>) -> 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<T> StructuralPartialEq for Motion<T>