mod timeline

module timeline

A Timeline which contains multiple Keyframes and allows interpolating between them.

A Keyframe’s value will start at the Keyframe’s time. It will then interpolate for the Keyframe’s specified duration, after which it will be held until the next Keyframe. If a new Keyframe starts while another one would be interpolating, the new Keyframe will take precedence (which leads to a jump to the previous Keyframe’s value at the start of the new Keyframe).

Types

type Time

Traits

trait Duration

Functions

fn as_f32(&self) -> f32

Convert this duration to f32

Implemented for

impl Duration for f32

impl Duration for ()

Structs and Unions

struct Keyframe<A, T, Dur: Duration>

A single keyframe.

Keyframes are ordered only by their time.

time: Time

The start-time of this keyframe

duration: Dur

The duration this keyframe will interpolate for

argument: A

Additional data for the interpolator

value: T

The value this keyframe will interpolate to

Implementations

impl<A, T, Dur: Duration> Keyframe<A, T, Dur>

Functions

fn argument(&self) -> &A

The argument of this keyframe (used for interpolation)

fn duration(&self) -> f32

The duration this keyframe will interpolate for

fn time(&self) -> &Time

The start-time of this keyframe

fn value(&self) -> &T

The value this keyframe will interpolate to

Traits implemented

impl<A, T, Dur: Duration> PartialEq for Keyframe<A, T, Dur>

impl<A, T, Dur: Duration> Eq for Keyframe<A, T, Dur>

impl<A, T, Dur: Duration> PartialOrd for Keyframe<A, T, Dur>

impl<A, T, Dur: Duration> Ord for Keyframe<A, T, Dur>

impl<T> From<(Time, T)> for Keyframe<(), T, ()>

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

impl<T, Dur: Duration> From<(Time, Dur, T)> for Keyframe<(), T, Dur>

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

impl<A, T, Dur: Duration> From<(Time, Dur, A, T)> for Keyframe<A, T, Dur>

impl<A, T, Dur: Duration> From<(f32, Dur, A, T)> for Keyframe<A, T, Dur>

struct Timeline<A: Copy, T: Copy, Dur: Duration, I: InterpolationFunction<A, T>>

A timeline which holds many keyframes and specifies the used interpolation function.

Implementations

impl<A: Copy, T: Copy, Dur: Duration, I: InterpolationFunction<A, T> + Default> Timeline<A, T, Dur, I>

Functions

fn new(default: T) -> Self

Creates a new Timeline with the passed default-value and the default interpolation parameters

impl<A: Copy, T: Copy, Dur: Duration, I: InterpolationFunction<A, T>> Timeline<A, T, Dur, I>

Functions

fn add(&mut self, keyframe: impl Into<Keyframe<A, T, Dur>>) -> &mut Self

Adds a keyframe into this Timeline

fn add_all(&mut self, keyframes: impl IntoIterator<Item = impl Into<Keyframe<A, T, Dur>>>) -> &mut Self

Adds multiple keyframes into this Timeline

fn get(&self, time: Time) -> T

Gets the value at the passed time. Will interpolate the keyframe.

fn new_with_interpolation(default: T, interpolation_function: I) -> Self

Creates a new Timeline with the passed default-value and the specified interpolation parameters

Traits implemented

impl<A: Copy, T: Copy + Default, Dur: Duration, I: InterpolationFunction<A, T> + Default> Default for Timeline<A, T, Dur, I>