Trait tween::Tween

pub trait Tween<Value> {
    // Required method
    fn tween(&mut self, value_delta: Value, percent: f32) -> Value;

    // Provided method
    fn is_finite(&self) -> bool { ... }
}

This is the core trait of the Library, which all tweens implement.

Required Methods

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

Linear, for example, is implemented simply as:

value_delta.scale(percent)

which is just value_delta * percent.

Provided Methods

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

This is used by Tweener and FixedTweener to determine when to clamp and when a tween will return true for Tweener::is_finished.

If you have a Tween which returns valid values at all percentage ranges at all times, you should return false.

If you would like to extrapolate a tween beyond its bounds, you can wrap it in Extrapolator.

Trait Implementations

impl<'a, Value> Tween<Value> for &'a mut dyn Tween<Value>

where Value: TweenValue,

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value>>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Send>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Send + Sync>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Send + Sync + Unpin>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Send + Unpin>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Sync>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Unpin>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

Returns a new value based on the value_delta and the percent.

fn is_finite(&self) -> bool

All Tweens in this library use this default method, except Looper and Oscillator, which which are both unbounded (because they never stop returning values), and Extrapolator, which simply unbounds tweens.

Implementations on Foreign Types

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Send + Sync + Unpin>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

fn is_finite(&self) -> bool

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Send + Sync>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

fn is_finite(&self) -> bool

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Send + Unpin>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

fn is_finite(&self) -> bool

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Send>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

fn is_finite(&self) -> bool

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Sync>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

fn is_finite(&self) -> bool

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value> + Unpin>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

fn is_finite(&self) -> bool

impl<Value: TweenValue> Tween<Value> for Box<dyn Tween<Value>>

fn tween(&mut self, value_delta: Value, percent: f32) -> Value

fn is_finite(&self) -> bool

Implementors

impl<'a, Value> Tween<Value> for &'a mut dyn Tween<Value>

where Value: TweenValue,

impl<Value> Tween<Value> for BackIn

where Value: TweenValue,

impl<Value> Tween<Value> for BackInOut

where Value: TweenValue,

impl<Value> Tween<Value> for BackOut

where Value: TweenValue,

impl<Value> Tween<Value> for BounceIn

where Value: TweenValue,

impl<Value> Tween<Value> for BounceInOut

where Value: TweenValue,

impl<Value> Tween<Value> for BounceOut

where Value: TweenValue,

impl<Value> Tween<Value> for CircIn

where Value: TweenValue,

impl<Value> Tween<Value> for CircInOut

where Value: TweenValue,

impl<Value> Tween<Value> for CircOut

where Value: TweenValue,

impl<Value> Tween<Value> for CubicIn

where Value: TweenValue,

impl<Value> Tween<Value> for CubicInOut

where Value: TweenValue,

impl<Value> Tween<Value> for CubicOut

where Value: TweenValue,

impl<Value> Tween<Value> for ElasticIn

where Value: TweenValue,

impl<Value> Tween<Value> for ElasticInOut

where Value: TweenValue,

impl<Value> Tween<Value> for ElasticOut

where Value: TweenValue,

impl<Value> Tween<Value> for ExpoIn

where Value: TweenValue,

impl<Value> Tween<Value> for ExpoInOut

where Value: TweenValue,

impl<Value> Tween<Value> for ExpoOut

where Value: TweenValue,

impl<Value> Tween<Value> for Linear

where Value: TweenValue,

impl<Value> Tween<Value> for QuadIn

where Value: TweenValue,

impl<Value> Tween<Value> for QuadInOut

where Value: TweenValue,

impl<Value> Tween<Value> for QuadOut

where Value: TweenValue,

impl<Value> Tween<Value> for QuartIn

where Value: TweenValue,

impl<Value> Tween<Value> for QuartInOut

where Value: TweenValue,

impl<Value> Tween<Value> for QuartOut

where Value: TweenValue,

impl<Value> Tween<Value> for QuintIn

where Value: TweenValue,

impl<Value> Tween<Value> for QuintInOut

where Value: TweenValue,

impl<Value> Tween<Value> for QuintOut

where Value: TweenValue,

impl<Value> Tween<Value> for SineIn

where Value: TweenValue,

impl<Value> Tween<Value> for SineInOut

where Value: TweenValue,

impl<Value> Tween<Value> for SineOut

where Value: TweenValue,

impl<Value, F> Tween<Value> for F

where F: FnMut(Value, f32) -> Value, Value: TweenValue,

impl<Value, T> Tween<Value> for Extrapolator<T>

where Value: TweenValue, T: Tween<Value>,

impl<Value, T> Tween<Value> for Looper<T>

where Value: TweenValue, T: Tween<Value>,

impl<Value, T> Tween<Value> for Oscillator<T>

where Value: TweenValue, T: Tween<Value>,