Struct tween::Oscillator

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

An Oscillator is a wrapper around a Tween which places the Tween into an infinite ping pong.

This is similar to a Looper, but instead of restarting the tween at the beginning, it restarts it at the end and travels backwards. For many Tweens in this library, this is the same

Tuple Fields

0: T

Implementations

impl<T> Oscillator<T>

pub fn new(tween: T) -> Self

Creates a new Oscillator around a Tween.

Trait Implementations

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

fn clone(&self) -> Oscillator<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 Oscillator<T>

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

Formats the value using the given formatter.

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

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

This method returns an Ordering between self and other.

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

fn eq(&self, other: &Oscillator<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 Oscillator<T>

fn partial_cmp(&self, other: &Oscillator<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 Oscillator<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 Oscillator<T>

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

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