Struct nannou_timeline::track::automation::numeric::Envelope

pub struct Envelope<T> {
    pub min: T,
    pub max: T,
    pub env: Envelope<T>,
}

An envelope with some min and max for the value range.

Fields

min: T

max: T

env: Envelope<T>

Implementations

impl<T> Envelope<T>

pub fn new(min: T, max: T) -> Envelope<T>

Construct a new, empty, default Envelope.

pub fn from_points<I>(points: I, min: T, max: T) -> Envelope<T> where
    I: IntoIterator<Item = Point<T>>, 

Construct a new Envelope from the given min, max and points.

Trait Implementations

impl<T: Clone> Clone for Envelope<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Envelope<T>

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

Formats the value using the given formatter.

impl<'a, T: 'a> Envelope<'a> for Envelope<T> where
    T: PartialEq + Spatial,
    Point<T>: PointTrait<X = Ticks, Y = T>, 

type X = Ticks

type Y = T

type Point = Point<T>

The Point type which may be referenced and interpolated by the Envelope.

type Points = Iter<'a, Point<T>>

An iterator yielding references to Self::Points.

fn points(&'a self) -> Self::Points

An iterator yielding the Points of the Envelope.

fn point_idx_before(&'a self, x: Self::X) -> Option<usize>

The index of the Point that comes directly before the given x.

fn point_idx_on_or_before(&'a self, x: Self::X) -> Option<usize>

The index of the Point that either lands on or comes directly before the given x.

fn point_idx_after(&'a self, x: Self::X) -> Option<usize>

The index of the Point that comes directly after the given x.

fn point_idx_on_or_after(&'a self, x: Self::X) -> Option<usize>

The index of the Point that comes directly after the given x.

fn point_before(&'a self, x: Self::X) -> Option<&'a Self::Point>

A reference to the first point that comes before the given x.

fn point_on_or_before(&'a self, x: Self::X) -> Option<&'a Self::Point>

A reference to the first point that is equal to or comes before the given x.

fn point_before_with_idx(
    &'a self,
    x: Self::X
) -> Option<(usize, &'a Self::Point)>

A reference to the first point that comes before the given x along with its index.

fn point_on_or_before_with_idx(
    &'a self,
    x: Self::X
) -> Option<(usize, &'a Self::Point)>

A reference to the first point that is equal to or comes before the given x along with its index.

fn point_after(&'a self, x: Self::X) -> Option<&'a Self::Point>

A reference to the first point that comes after the given x.

fn point_on_or_after(&'a self, x: Self::X) -> Option<&'a Self::Point>

A reference to the first point that is equal to or comes after the given x.

fn point_after_with_idx(
    &'a self,
    x: Self::X
) -> Option<(usize, &'a Self::Point)>

A reference to the first point that comes after the given x along with its index.

fn point_on_or_after_with_idx(
    &'a self,
    x: Self::X
) -> Option<(usize, &'a Self::Point)>

A reference to the first point that is equal to or comes after the given x along with its index.

fn point_at(&'a self, x: Self::X) -> Option<&'a Self::Point>

A reference to the first point lying directly on the given x if there is one.

fn point_at_with_idx(&'a self, x: Self::X) -> Option<(usize, &'a Self::Point)>

A reference to the first point (along with it's index) lying directly on the given x if there is one.

fn surrounding_points(
    &'a self,
    x: Self::X
) -> (Option<&'a Self::Point>, Option<&'a Self::Point>)

The points that lie on either side of the given x.

fn closest_point(&'a self, x: Self::X) -> Option<&'a Self::Point> where
    Self::X: Sub<Self::X>,
    <Self::X as Sub<Self::X>>::Output == Self::X, 

A reference point that is closest to the given x if there is one.

fn y(&'a self, x: Self::X) -> Option<Self::Y> where
    <Self::Y as Spatial>::Scalar: Scalar, 

Return y for the given x.

fn steps(&'a self, start: Self::X, step: Self::X) -> Option<Steps<'a, Self>>

Sample the Envelope's y value for every given positive x step starting from the first point's X value.

impl From<Envelope<Bang>> for Dynamic

fn from(env: Envelope<Bang>) -> Self

Performs the conversion.

impl From<Envelope<Toggle>> for Dynamic

fn from(env: Envelope<Toggle>) -> Self

Performs the conversion.

impl From<Envelope<f32>> for Dynamic

fn from(env: Envelope<f32>) -> Self

Performs the conversion.

impl From<Envelope<f64>> for Dynamic

fn from(env: Envelope<f64>) -> Self

Performs the conversion.

impl From<Envelope<i16>> for Dynamic

fn from(env: Envelope<i16>) -> Self

Performs the conversion.

impl From<Envelope<i32>> for Dynamic

fn from(env: Envelope<i32>) -> Self

Performs the conversion.

impl From<Envelope<i64>> for Dynamic

fn from(env: Envelope<i64>) -> Self

Performs the conversion.

impl From<Envelope<i8>> for Dynamic

fn from(env: Envelope<i8>) -> Self

Performs the conversion.

impl From<Envelope<u16>> for Dynamic

fn from(env: Envelope<u16>) -> Self

Performs the conversion.

impl From<Envelope<u32>> for Dynamic

fn from(env: Envelope<u32>) -> Self

Performs the conversion.

impl From<Envelope<u64>> for Dynamic

fn from(env: Envelope<u64>) -> Self

Performs the conversion.

impl From<Envelope<u8>> for Dynamic

fn from(env: Envelope<u8>) -> Self

Performs the conversion.

impl<T: PartialEq> PartialEq<Envelope<T>> for Envelope<T>

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

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

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

This method tests for !=.

impl<T> StructuralPartialEq for Envelope<T>