Struct Interpolator 

pub struct Interpolator { /* private fields */ }

A interpolator that interpolates values in range.

Implementations

impl Interpolator

pub fn new(lower: f32, upper: f32) -> Self

Create a new interpolator with the given lower and upper bounds.

Examples

let interpolator = Interpolator::new(0.0, 1.0);
assert_eq!(interpolator.head(), 0.0);
assert_eq!(interpolator.tail(), 1.0);

pub fn head(&self) -> f32

Get the left most value of the interpolator, if not set, the lower bound is returned.

Examples

let mut interpolator = Interpolator::default();
assert_eq!(interpolator.head(), 0.0);
interpolator.insert(0, 0.5);
assert_eq!(interpolator.head(), 0.5);

pub fn tail(&self) -> f32

Get the right most value of the interpolator, if not set, the upper bound is returned.

Examples

let mut interpolator = Interpolator::default();
assert_eq!(interpolator.tail(), 1.0);
interpolator.insert(65535, 0.5);
assert_eq!(interpolator.tail(), 0.5);

pub fn insert(&mut self, key: u16, value: f32)

Insert a new key value pair into the interpolator, overwriting any existing value.

Examples

let mut gradient = Interpolator::default();
gradient.insert(0, 0.5);
gradient.insert(65535, 0.5);
assert_eq!(gradient.head(), 0.5);
assert_eq!(gradient.tail(), 0.5);

pub fn remove(&mut self, key: u16)

Remove a key value pair from the interpolator.

Examples

let mut gradient = Interpolator::default();
gradient.insert(0, 0.5);
assert_eq!(gradient.head(), 0.5);
gradient.remove(0);
assert_eq!(gradient.head(), 0.0);

pub fn clear(&mut self)

Clear all key value pairs from the interpolator.

Examples

impl Interpolator

pub fn get_step(&self, key: u16) -> f32

Get zero-order interpolation, that is, the first number greater than ratio

pub fn get_linear(&self, key: u16) -> f32

Get first-order linear interpolation

pub fn get_bezier(&self, key: u16) -> f32

Get bezier interpolation

Trait Implementations

impl Clone for Interpolator

fn clone(&self) -> Interpolator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interpolator

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

Formats the value using the given formatter.

impl Default for Interpolator

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Interpolator

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Interpolator

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

where __S: Serializer,

Serialize this value into the given Serde serializer.