Skip to main content

AnimChannel

Struct AnimChannel 

Source
pub struct AnimChannel {
    pub from: f32,
    pub to: f32,
    pub current: f32,
    pub velocity: f32,
    pub elapsed_secs: f32,
    pub mode: InterpolationMode,
    /* private fields */
}
Expand description

A single animated value over time (e.g., an x-coordinate or opacity).

Complex animations are created by combining multiple channels. For example, moving an element in 2D requires four channels: x and y translation, and x and y scale.

Fields§

§from: f32

Where the value started. Re-seeded on every retarget.

§to: f32

Where it is heading.

§current: f32

The current value to write into the cascade.

§velocity: f32

Units per second. Carried across retargets.

§elapsed_secs: f32

Seconds since the animation began (curve mode only).

§mode: InterpolationMode

How it is driven.

Implementations§

Source§

impl AnimChannel

Source

pub const fn curve( from: f32, to: f32, function: AnimationInterpolationFunction, duration_secs: f32, ) -> Self

A channel that eases from → to over duration_secs.

Source

pub const fn spring(from: f32, to: f32, spring: Spring) -> Self

A channel that springs from → to.

Source

pub fn tick(&mut self, dt: f32) -> f32

Advance by dt seconds and return the new current value.

Source

pub const fn is_finished(&self) -> bool

Whether this channel has arrived at the target value and can be dropped (animation finished)

Source

pub fn retarget(&mut self, new_to: f32)

Aim at a new target without losing the current value or velocity.

This allows smooth retargeting mid-flight.

Trait Implementations§

Source§

impl Clone for AnimChannel

Source§

fn clone(&self) -> AnimChannel

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 Copy for AnimChannel

Source§

impl Debug for AnimChannel

Source§

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

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

impl PartialEq for AnimChannel

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AnimChannel

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