Enum splines::interpolation::Interpolation

#[non_exhaustive]
pub enum Interpolation<T, V> {
    Step(T),
    Linear,
    Cosine,
    CatmullRom,
    Bezier(V),
    StrokeBezier(V, V),
}

Available kind of interpolations.

Feel free to visit each variant for more documentation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Step(T)

Hold a Key until the sampling value passes the normalized step threshold, in which case the next key is used.

Note: if you set the threshold to 0.5, the first key will be used until half the time between the two keys; the second key will be in used afterwards. If you set it to 1.0, the first key will be kept until the next key. Set it to 0. and the first key will never be used.

Linear

Linear interpolation between a key and the next one.

Cosine

Cosine interpolation between a key and the next one.

CatmullRom

Catmull-Rom interpolation, performing a cubic Hermite interpolation using four keys.

Bezier(V)

Bézier interpolation.

A control point that uses such an interpolation is associated with an extra point. The segmant connecting both is called the tangent of this point. The part of the spline defined between this control point and the next one will be interpolated across with Bézier interpolation. Two cases are possible:

• The next control point also has a Bézier interpolation mode. In this case, its tangent is used for the interpolation process. This is called cubic Bézier interpolation and it kicks ass.
• The next control point doesn’t have a Bézier interpolation mode set. In this case, the tangent used for the next control point is defined as the segment connecting that control point and the current control point’s associated point. This is called quadratic Bézer interpolation and it kicks ass too, but a bit less than cubic.

StrokeBezier(V, V)

A special Bézier interpolation using an input tangent and an output tangent.

With this kind of interpolation, a control point has an input tangent, which has the same role as the one defined by Interpolation::Bezier, and an output tangent, which has the same role defined by the next key’s Interpolation::Bezier if present, normally.

What it means is that instead of setting the output tangent as the next key’s Bézier tangent, this interpolation mode allows you to manually set the output tangent. That will yield more control on the tangents but might generate discontinuities. Use with care.

Stroke Bézier interpolation is always a cubic Bézier interpolation by default.

Trait Implementations

impl<T: Clone, V: Clone> Clone for Interpolation<T, V>

fn clone(&self) -> Interpolation<T, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, V: Debug> Debug for Interpolation<T, V>

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

Formats the value using the given formatter.

impl<T, V> Default for Interpolation<T, V>

fn default() -> Self

Interpolation::Linear is the default.

impl<'de, T, V> Deserialize<'de> for Interpolation<T, V> where
    T: Deserialize<'de>,
    V: 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: PartialEq, V: PartialEq> PartialEq<Interpolation<T, V>> for Interpolation<T, V>

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

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

fn ne(&self, other: &Interpolation<T, V>) -> bool

This method tests for !=.

impl<T, V> Serialize for Interpolation<T, V> where
    T: Serialize,
    V: 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: Copy, V: Copy> Copy for Interpolation<T, V>

impl<T: Eq, V: Eq> Eq for Interpolation<T, V>

impl<T, V> StructuralEq for Interpolation<T, V>

impl<T, V> StructuralPartialEq for Interpolation<T, V>