Skip to main content

Motion

Struct Motion 

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

A value the runtime animates for a widget.

Start a transition with ctx.animate(&mut motion, target, spec) and read the value while painting with motion.get(ctx). The runtime invalidates the widget every frame until the transition ends, so the widget needs no animation-frame handling of its own. The value is a function of time, so reading it at a frame’s time gives what is on screen then.

Transitions follow the MotionPolicy; retargeting mid-flight keeps momentum (see MotionValue).

Implementations§

Source§

impl<T: Copy> Motion<T>

Source

pub const fn new(value: T) -> Self

Source

pub const fn invalidating(self, kind: InvalidationKind) -> Self

What the runtime invalidates each frame while this animates: Paint (the default) for values read while painting, Transform or Effect for layer properties, Measure for sizes.

Source

pub const fn movement(self) -> Self

Mark this as movement, such as a sliding indicator: reduced motion finishes it immediately instead of animating it.

Source

pub const fn invalidation(&self) -> InvalidationKind

Source

pub const fn is_movement(&self) -> bool

Source

pub fn target(&self) -> T

The value this motion is heading to.

Source

pub fn jump_to(&mut self, value: T)

Stop animating and rest at value.

Source§

impl<T> Motion<T>
where T: Interpolate + Copy + PartialEq,

Source

pub fn get(&self, clock: &impl FrameClock) -> T

The value at the time of the frame clock is producing.

Source

pub fn at(&self, time: f64) -> T

The value at time.

Source

pub fn is_animating(&self, clock: &impl FrameClock) -> bool

Whether a transition is running at the time of clock’s frame.

Source

pub fn end_time(&self) -> Option<f64>

When the running transition ends, or None at rest.

Source

pub fn start( &mut self, target: T, time: f64, spec: AnimationSpec, ) -> Option<f64>

Start toward target at time with spec under the motion policy. Returns when the transition ends if one started. Contexts’ animate methods call this and keep the widget invalidated until then.

Source

pub fn start_after( &mut self, target: T, time: f64, delay: f64, spec: AnimationSpec, ) -> Option<f64>

Like Motion::start, delay seconds after time. The delay follows the policy’s time scale, and is skipped when the policy makes the transition instant.

Trait Implementations§

Source§

impl<T: Clone> Clone for Motion<T>

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<T: Copy> Copy for Motion<T>

Source§

impl<T: Debug> Debug for Motion<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: PartialEq> PartialEq for Motion<T>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<T: PartialEq> StructuralPartialEq for Motion<T>

Auto Trait Implementations§

§

impl<T> Forget for Motion<T>

§

impl<T> Freeze for Motion<T>
where MotionValue<T>: Freeze,

§

impl<T> Move for Motion<T>

§

impl<T> RefUnwindSafe for Motion<T>

§

impl<T> Send for Motion<T>
where MotionValue<T>: Send,

§

impl<T> Sync for Motion<T>
where MotionValue<T>: Sync,

§

impl<T> Unpin for Motion<T>
where MotionValue<T>: Unpin,

§

impl<T> UnsafeUnpin for Motion<T>

§

impl<T> UnwindSafe for Motion<T>

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