Type Alias EasingStep

pub type EasingStep = Factor;

Easing function output.

Usually in the [0..=1] range, but can overshoot. An easing function converts a EasingTime into this factor.

Examples

use zng_unit::*;
use zng_var::animation::easing::{EasingStep, EasingTime};

/// Cubic animation curve.
fn cubic(time: EasingTime) -> EasingStep {
    let f = time.fct();
    f * f * f
}

Note that all the common easing functions are implemented in easing.

Aliased Type

struct EasingStep(pub f32);

Fields

0: f32

Implementations

impl Factor

pub fn clamp_range(self) -> Factor

Clamp factor to [0.0..=1.0] range.

pub fn max(self, other: impl Into<Factor>) -> Factor

Returns the maximum of two factors.

pub fn min(self, other: impl Into<Factor>) -> Factor

Returns the minimum of two factors.

pub fn clamp(self, min: impl Into<Factor>, max: impl Into<Factor>) -> Factor

Returns self if min <= self <= max, returns min if self < min or returns max if self > max.

pub fn abs(self) -> Factor

Computes the absolute value of self.

pub fn flip(self) -> Factor

Flip factor, around 0.5,

Returns 1.0 - self.

pub fn pct(self) -> FactorPercent

Factor as percentage.

Trait Implementations

impl Add for Factor

type Output = Factor

The resulting type after applying the + operator.

fn add(self, rhs: Factor) -> <Factor as Add>::Output

Performs the + operation.

impl AddAssign for Factor

fn add_assign(&mut self, rhs: Factor)

Performs the += operation.

impl Clone for Factor

fn clone(&self) -> Factor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Factor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Factor

fn deserialize<__D>( __deserializer: __D, ) -> Result<Factor, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Factor

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

Formats the value using the given formatter.

impl Div for Factor

type Output = Factor

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> <Factor as Div>::Output

Performs the / operation.

impl DivAssign for Factor

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl From<FactorPercent> for Factor

fn from(value: FactorPercent) -> Factor

Converts to this type from the input type.

impl From<bool> for Factor

fn from(value: bool) -> Factor

Converts to this type from the input type.

impl From<f32> for Factor

fn from(value: f32) -> Factor

Converts to this type from the input type.

impl Hash for Factor

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoVar<EasingTime> for Factor

type Var = LocalVar<EasingTime>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> BoxedVar<T>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<FactorPercent> for Factor

type Var = LocalVar<FactorPercent>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> BoxedVar<T>

where Self: Sized,

Converts into BoxedVar<T>.

impl Mul for Factor

type Output = Factor

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> <Factor as Mul>::Output

Performs the * operation.

impl MulAssign for Factor

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl Neg for Factor

type Output = Factor

The resulting type after applying the - operator.

fn neg(self) -> <Factor as Neg>::Output

Performs the unary - operation.

impl PartialEq for Factor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Factor

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Factor

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Factor

type Output = Factor

The resulting type after applying the - operator.

fn sub(self, rhs: Factor) -> <Factor as Sub>::Output

Performs the - operation.

impl SubAssign for Factor

fn sub_assign(&mut self, rhs: Factor)

Performs the -= operation.

impl Transitionable for Factor

fn lerp(self, to: &Self, step: EasingStep) -> Self

Sample the linear interpolation from self -> to by step.

impl Zeroable for Factor

fn zeroed() -> Self

Calls zeroed.

impl Copy for Factor

impl IntoValue<EasingTime> for Factor

impl IntoValue<FactorPercent> for Factor

impl Pod for Factor