Struct vek::transition::Transition

pub struct Transition<T, F, Progress = f32> {
    pub start: T,
    pub end: T,
    pub progress: Progress,
    pub progress_mapper: F,
}

A convenience structure for storing a progression from one value to another.

Fields

start: T

The value when progress gets close to 0.

end: T

The value when progress gets close to 1.

progress: Progress

Expected to be between 0 and 1.

progress_mapper: F

Functor that maps the current progress value to a LERP factor.

Implementations

impl<T, F, Progress> Transition<T, F, Progress>

pub fn with_mapper(start: T, end: T, progress_mapper: F) -> Self where
    Progress: Zero, 

Creates a new Transition from start and end values and progress_mapper, setting progress to zero.

pub fn with_mapper_and_progress(
    start: T,
    end: T,
    progress_mapper: F,
    progress: Progress
) -> Self

Creates a new Transition from start, end, progress_mapper and progress values.

pub fn into_range(self) -> Range<T>

Converts this into a Range, dropping the progress and progress_mapper values.

impl<T, F, Progress> Transition<T, F, Progress> where
    F: ProgressMapper<Progress>, 

pub fn into_current(self) -> T where
    T: Lerp<Progress, Output = T>,
    Progress: Clamp + Zero + One, 

Gets the transition's current state, clamping progress to [0;1].

pub fn into_current_unclamped(self) -> T where
    T: Lerp<Progress, Output = T>, 

Gets the transition's current state using the progress value as-is.

pub fn into_current_precise(self) -> T where
    T: Lerp<Progress, Output = T>,
    Progress: Clamp + Zero + One, 

Gets the transition's current state, clamping progress to [0;1].

pub fn into_current_unclamped_precise(self) -> T where
    T: Lerp<Progress, Output = T>, 

Gets the transition's current state using the progress value as-is.

pub fn current<'a>(&'a self) -> T where
    &'a T: Lerp<Progress, Output = T>,
    Progress: Copy + Clamp + Zero + One, 

Gets the transition's current state, clamping progress to [0;1].

pub fn current_unclamped<'a>(&'a self) -> T where
    &'a T: Lerp<Progress, Output = T>,
    Progress: Copy, 

Gets the transition's current state using the progress value as-is.

pub fn current_precise<'a>(&'a self) -> T where
    &'a T: Lerp<Progress, Output = T>,
    Progress: Copy + Clamp + Zero + One, 

Gets the transition's current state, clamping progress to [0;1].

pub fn current_unclamped_precise<'a>(&'a self) -> T where
    &'a T: Lerp<Progress, Output = T>,
    Progress: Copy, 

Gets the transition's current state using the progress value as-is.

impl<T, Progress> Transition<T, IdentityProgressMapper, Progress>

pub fn new(start: T, end: T) -> Self where
    Progress: Zero, 

Creates a new LinearTransition from start and end values, setting progress to zero.

pub fn with_progress(start: T, end: T, progress: Progress) -> Self

Creates a new LinearTransition from start, end and progress values.

Trait Implementations

impl<T: Clone, F: Clone, Progress: Clone> Clone for Transition<T, F, Progress>

fn clone(&self) -> Transition<T, F, Progress>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, F: Copy, Progress: Copy> Copy for Transition<T, F, Progress>

impl<T: Debug, F: Debug, Progress: Debug> Debug for Transition<T, F, Progress>

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

Formats the value using the given formatter.

impl<T: Default, F: Default, Progress: Zero> Default for Transition<T, F, Progress>

fn default() -> Self

Returns the "default value" for a type.

impl<'de, T, F, Progress> Deserialize<'de> for Transition<T, F, Progress> where
    T: Deserialize<'de>,
    F: Deserialize<'de>,
    Progress: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<T: Eq, F: Eq, Progress: Eq> Eq for Transition<T, F, Progress>

impl<T, F: Default, Progress: Zero> From<Range<T>> for Transition<T, F, Progress>

fn from(r: Range<T>) -> Self

Performs the conversion.

impl<T: Hash, F: Hash, Progress: Hash> Hash for Transition<T, F, Progress>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq, F: PartialEq, Progress: PartialEq> PartialEq<Transition<T, F, Progress>> for Transition<T, F, Progress>

fn eq(&self, other: &Transition<T, F, Progress>) -> bool

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

fn ne(&self, other: &Transition<T, F, Progress>) -> bool

This method tests for !=.

impl<T, F, Progress> Serialize for Transition<T, F, Progress> where
    T: Serialize,
    F: Serialize,
    Progress: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T, F, Progress> StructuralEq for Transition<T, F, Progress>

impl<T, F, Progress> StructuralPartialEq for Transition<T, F, Progress>