Struct spectra::spline::Spline

pub struct Spline<T> { /* fields omitted */ }

Spline curve used to provide interpolation between control points (keys).

Methods

impl<T> Spline<T>

fn from_keys(keys: Vec<Key<T>>) -> Self

Create a new spline out of keys. The keys don’t have to be sorted because they’re sorted by this function.

fn sample(&self, t: Time) -> Option<T> where
    T: Interpolate, 

Sample a spline at a given time.

Return

None if you try to sample a value at a time that has no key associated with. That can also happen if you try to sample between two keys with a specific interpolation mode that make the sampling impossible. For instance, Interpolate::CatmullRom requires four keys. If you’re near the beginning of the spline or its end, ensure you have enough keys around to make the sampling.

fn clamped_sample(&self, t: Time) -> T where
    T: Interpolate, 

Sample a spline at a given time with clamping.

Return

If you sample before the first key or after the last one, return the first key or the last one, respectively.

Panic

This function panics if you have no key.

Trait Implementations

impl<T: Debug> Debug for Spline<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Clone> Clone for Spline<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Load for Spline<T> where
    T: SplineDeserializerAdapter, 

type Args = ()

Arguments passed at loading.

const TY_STR: &'static str

TY_STR: &'static str = "splines"

fn load<P>(path: P, _: &mut ResCache, _: Self::Args) -> Result<Self, LoadError> where
    P: AsRef<Path>, 

impl<'a, T> IntoIterator for &'a Spline<T>

type Item = &'a Key<T>

The type of the elements being iterated over.

type IntoIter = SplineIterator<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.