Keyframe

Struct Keyframe 

Source
pub struct Keyframe<T: Tweenable> { /* private fields */ }
Expand description

A keyframe representing a value at a specific time.

§Type Parameters

  • T: The value type, must implement Tweenable.

§Examples

use eazy_keyframes::Keyframe;
use eazy_core::Easing;

// Keyframe at 50% with OutBounce easing
let kf = Keyframe::new(0.5, 100.0_f32)
  .with_easing(Easing::OutBounce);

Implementations§

Source§

impl<T: Tweenable> Keyframe<T>

Source

pub fn new(time: f32, value: T) -> Self

Create a new keyframe at the given time with the given value.

Source

pub fn with_easing(self, easing: Easing) -> Self

Create a keyframe with easing.

Source

pub fn set_easing(&mut self, easing: Option<Easing>)

Set the easing function.

Source

pub fn time(&self) -> f32

Get the time position.

Source

pub fn value(&self) -> T

Get the value.

Source

pub fn easing(&self) -> Option<&Easing>

Get the easing function.

Source

pub fn has_easing(&self) -> bool

Check if this keyframe has custom easing.

Source

pub fn tween_to(&self, next: &Keyframe<T>, time: f32) -> T

Interpolate from this keyframe to the next at the given time.

Uses the easing function from next (since easing controls interpolation TO a keyframe).

§Behavior
  • If time <= self.time: returns self.value
  • If time >= next.time: returns next.value
  • If next.time <= self.time: returns next.value (invalid order)
  • Otherwise: interpolates using next.easing (or linear if None)
§Examples
use eazy_keyframes::Keyframe;
use eazy_core::Easing;

let kf1 = Keyframe::new(0.0, 0.0_f32);
let kf2 = Keyframe::new(1.0, 100.0_f32).with_easing(Easing::OutBounce);

let value = kf1.tween_to(&kf2, 0.5);

Trait Implementations§

Source§

impl<T: Clone + Tweenable> Clone for Keyframe<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Tweenable> Debug for Keyframe<T>

Source§

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

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

impl<T: Tweenable> From<(f32, T)> for Keyframe<T>

Create keyframe from (time, value) tuple with linear easing.

Source§

fn from((time, value): (f32, T)) -> Self

Converts to this type from the input type.
Source§

impl<T: Tweenable> From<(f32, T, Easing)> for Keyframe<T>

Create keyframe from (time, value, easing) tuple.

Source§

fn from((time, value, easing): (f32, T, Easing)) -> Self

Converts to this type from the input type.
Source§

impl<T: Tweenable> FromIterator<Keyframe<T>> for KeyframeTrack<T>

Source§

fn from_iter<I: IntoIterator<Item = Keyframe<T>>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl<T: Tweenable> PartialEq for Keyframe<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Tweenable> PartialOrd for Keyframe<T>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Keyframe<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Keyframe<T>
where T: RefUnwindSafe,

§

impl<T> Send for Keyframe<T>

§

impl<T> Sync for Keyframe<T>

§

impl<T> Unpin for Keyframe<T>
where T: Unpin,

§

impl<T> UnwindSafe for Keyframe<T>
where T: UnwindSafe,

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