Struct tween::Extrapolator

#[repr(transparent)]
pub struct Extrapolator<T: ?Sized>(pub T);

An Extrapolator is a wrapper around a Tween, which allows a tween to go beyond the range of 0.0 to 1.0. Note that for Looper, Oscillator, or any Tween whose Tween::is_finite returns false, wrapping in an Extrapolator is unnecssary, as they are already infinite tween.

As a note of caution, some Tweens, like Linear handle extrapolation just fine, but many others, like SineIn will give unhelpful results. They are clamped for a reason!

Tuple Fields

0: T

Implementations

impl<T> Extrapolator<T>

pub fn new(tween: T) -> Self

Creates a new Extrapolator around a Tween.

Trait Implementations

impl<T: Clone + ?Sized> Clone for Extrapolator<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for Extrapolator<T>

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

Formats the value using the given formatter.

impl<T: Ord + ?Sized> Ord for Extrapolator<T>

fn cmp(&self, other: &Extrapolator<T>) -> Ordering

This method returns an Ordering between self and other.

impl<T: PartialEq + ?Sized> PartialEq for Extrapolator<T>

fn eq(&self, other: &Extrapolator<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd + ?Sized> PartialOrd for Extrapolator<T>

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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

where Value: TweenValue, T: 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<T: Copy + ?Sized> Copy for Extrapolator<T>

impl<T: Eq + ?Sized> Eq for Extrapolator<T>

impl<T: ?Sized> StructuralPartialEq for Extrapolator<T>