TimeDataMap

token_value_map

Struct TimeDataMap

pub struct TimeDataMap<T> {
    pub values: BTreeMap<Time, T>,
}

Expand description

A mapping from time to data values with interpolation support.

Stores time-value pairs in a BTreeMap for efficient time-based queries and supports various interpolation methods.

When the interpolation feature is enabled, each value can have an associated interpolation specification for animation curves.

Without interpolation feature: BTreeMap<Time, T>.

With interpolation feature an entry supports a [Key]s: BTreeMap<Time, (T, Option<Key<T>>)>.

Fields§

§values: BTreeMap<Time, T>

The time-value pairs with optional interpolation keys.

Implementations§

impl<T> TimeDataMap<T>

pub fn iter(&self) -> impl Iterator<Item = (&Time, &T)>

Get an iterator over time-value pairs.

pub fn is_empty(&self) -> bool

Check if empty.

pub fn len(&self) -> usize

Get the number of entries.

impl<T> TimeDataMap<T>

pub fn insert(&mut self, time: Time, value: T)

Insert a value at the given time.

pub fn get(&self, time: &Time) -> Option<&T>

Get a value at the exact time.

impl<T> TimeDataMap<T>
where T: Clone + Add<Output = T> + Mul<f32, Output = T> + Sub<Output = T>,

pub fn interpolate(&self, time: Time) -> T

impl<T> TimeDataMap<T>

pub fn closest_sample(&self, time: Time) -> &T

pub fn sample_at(&self, time: Time) -> Option<&T>

Sample value at exact time (no interpolation).

pub fn sample_at_or_before(&self, time: Time) -> Option<&T>

Get the value at or before the given time.

pub fn sample_at_or_after(&self, time: Time) -> Option<&T>

Get the value at or after the given time.

pub fn sample_surrounding<const N: usize>( &self, time: Time, ) -> SmallVec<[(Time, &T); N]>

Get surrounding samples for interpolation.

Returns up to N samples centered around the given time for use in interpolation algorithms.

Trait Implementations§

impl<T> AnimatedDataOps for TimeDataMap<T>

fn len(&self) -> usize

Returns the number of time samples.

fn is_empty(&self) -> bool

Returns true if there are no time samples.

fn is_animated(&self) -> bool

Returns true if there is more than one time sample.

impl<T> AsRef<BTreeMap<Tick, T>> for TimeDataMap<T>

Available on non-crate feature interpolation only.

fn as_ref(&self) -> &BTreeMap<Time, T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for TimeDataMap<T>

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T> DataTypeOps for TimeDataMap<T>
where T: DataTypeOps,

fn data_type(&self) -> DataType

Returns the DataType variant for this value.

fn type_name(&self) -> &'static str

Returns a string name for this data type.

impl<T: Debug> Debug for TimeDataMap<T>

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

Formats the value using the given formatter. Read more

impl From<(Tick, Boolean)> for TimeDataMap<Boolean>

fn from((time, value): (Time, Boolean)) -> Self

Converts to this type from the input type.

impl From<(Tick, BooleanVec)> for TimeDataMap<BooleanVec>

fn from((time, value): (Time, BooleanVec)) -> Self

Converts to this type from the input type.

impl From<(Tick, Color)> for TimeDataMap<Color>

fn from((time, value): (Time, Color)) -> Self

Converts to this type from the input type.

impl From<(Tick, ColorVec)> for TimeDataMap<ColorVec>

fn from((time, value): (Time, ColorVec)) -> Self

Converts to this type from the input type.

impl From<(Tick, Data)> for TimeDataMap<Data>

fn from((time, value): (Time, Data)) -> Self

Converts to this type from the input type.

impl From<(Tick, Integer)> for TimeDataMap<Integer>

fn from((time, value): (Time, Integer)) -> Self

Converts to this type from the input type.

impl From<(Tick, IntegerVec)> for TimeDataMap<IntegerVec>

fn from((time, value): (Time, IntegerVec)) -> Self

Converts to this type from the input type.

impl From<(Tick, Matrix3)> for TimeDataMap<Matrix3>

fn from((time, value): (Time, Matrix3)) -> Self

Converts to this type from the input type.

impl From<(Tick, Matrix3Vec)> for TimeDataMap<Matrix3Vec>

fn from((time, value): (Time, Matrix3Vec)) -> Self

Converts to this type from the input type.

impl From<(Tick, Real)> for TimeDataMap<Real>

fn from((time, value): (Time, Real)) -> Self

Converts to this type from the input type.

impl From<(Tick, RealVec)> for TimeDataMap<RealVec>

fn from((time, value): (Time, RealVec)) -> Self

Converts to this type from the input type.

impl From<(Tick, String)> for TimeDataMap<String>

fn from((time, value): (Time, String)) -> Self

Converts to this type from the input type.

impl From<(Tick, StringVec)> for TimeDataMap<StringVec>

fn from((time, value): (Time, StringVec)) -> Self

Converts to this type from the input type.

impl From<(Tick, Vector2)> for TimeDataMap<Vector2>

fn from((time, value): (Time, Vector2)) -> Self

Converts to this type from the input type.

impl From<(Tick, Vector2Vec)> for TimeDataMap<Vector2Vec>

fn from((time, value): (Time, Vector2Vec)) -> Self

Converts to this type from the input type.

impl<T> From<BTreeMap<Tick, T>> for TimeDataMap<T>

fn from(values: BTreeMap<Time, T>) -> Self

Converts to this type from the input type.

impl From<TimeDataMap<Boolean>> for AnimatedData

fn from(v: TimeDataMap<Boolean>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<BooleanVec>> for AnimatedData

fn from(v: TimeDataMap<BooleanVec>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<Color>> for AnimatedData

fn from(v: TimeDataMap<Color>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<ColorVec>> for AnimatedData

fn from(v: TimeDataMap<ColorVec>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<Integer>> for AnimatedData

fn from(v: TimeDataMap<Integer>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<IntegerVec>> for AnimatedData

fn from(v: TimeDataMap<IntegerVec>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<Matrix3>> for AnimatedData

Available on crate feature matrix3 only.

fn from(v: TimeDataMap<Matrix3>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<Matrix3Vec>> for AnimatedData

Available on crate features matrix3 and vec_variants only.

fn from(v: TimeDataMap<Matrix3Vec>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<Real>> for AnimatedData

fn from(v: TimeDataMap<Real>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<RealVec>> for AnimatedData

fn from(v: TimeDataMap<RealVec>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<String>> for AnimatedData

fn from(v: TimeDataMap<String>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<StringVec>> for AnimatedData

fn from(v: TimeDataMap<StringVec>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<Vector2>> for AnimatedData

Available on crate feature vector2 only.

fn from(v: TimeDataMap<Vector2>) -> AnimatedData

Converts to this type from the input type.

impl From<TimeDataMap<Vector2Vec>> for AnimatedData

Available on crate features vector2 and vec_variants only.

fn from(v: TimeDataMap<Vector2Vec>) -> AnimatedData

Converts to this type from the input type.

impl<T, V> FromIterator<(Tick, V)> for TimeDataMap<T>
where V: Into<T>,

fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = (Time, V)>,

Creates a value from an iterator. Read more

impl<T: Hash> Hash for TimeDataMap<T>

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl<T: PartialEq> PartialEq for TimeDataMap<T>

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sample<Color> for TimeDataMap<Color>

fn sample( &self, shutter: &Shutter, samples: NonZeroU16, ) -> Result<Vec<(Color, SampleWeight)>>

Generate samples across the shutter interval. Read more

impl Sample<Integer> for TimeDataMap<Integer>

fn sample( &self, shutter: &Shutter, samples: NonZeroU16, ) -> Result<Vec<(Integer, SampleWeight)>>

Generate samples across the shutter interval. Read more

impl Sample<Matrix3> for TimeDataMap<Matrix3>

Available on crate feature matrix3 only.

fn sample( &self, shutter: &Shutter, samples: NonZeroU16, ) -> Result<Vec<(Matrix3, SampleWeight)>>

Generate samples across the shutter interval. Read more

impl Sample<Real> for TimeDataMap<Real>

fn sample( &self, shutter: &Shutter, samples: NonZeroU16, ) -> Result<Vec<(Real, SampleWeight)>>

Generate samples across the shutter interval. Read more

impl Sample<Vector2> for TimeDataMap<Vector2>

fn sample( &self, shutter: &Shutter, samples: NonZeroU16, ) -> Result<Vec<(Vector2, SampleWeight)>>

Generate samples across the shutter interval. Read more

impl<T> TimeDataMapControl<T> for TimeDataMap<T>

fn len(&self) -> usize

Returns the number of time samples.

fn is_empty(&self) -> bool

Returns true if there are no time samples.

fn is_animated(&self) -> bool

Returns true if there is more than one time sample.

impl TryInto<TimeDataMap<Boolean>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Boolean>, <Self as TryInto<TimeDataMap<Boolean>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<BooleanVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<BooleanVec>, <Self as TryInto<TimeDataMap<BooleanVec>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<Color>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Color>, <Self as TryInto<TimeDataMap<Color>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<ColorVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<ColorVec>, <Self as TryInto<TimeDataMap<ColorVec>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<Integer>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Integer>, <Self as TryInto<TimeDataMap<Integer>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<IntegerVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<IntegerVec>, <Self as TryInto<TimeDataMap<IntegerVec>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<Matrix3>> for AnimatedData

Available on crate feature matrix3 only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Matrix3>, <Self as TryInto<TimeDataMap<Matrix3>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<Matrix3Vec>> for AnimatedData

Available on crate features matrix3 and vec_variants only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Matrix3Vec>, <Self as TryInto<TimeDataMap<Matrix3Vec>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<Real>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Real>, <Self as TryInto<TimeDataMap<Real>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<RealVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<RealVec>, <Self as TryInto<TimeDataMap<RealVec>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<String>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<String>, <Self as TryInto<TimeDataMap<String>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<StringVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<StringVec>, <Self as TryInto<TimeDataMap<StringVec>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<Vector2>> for AnimatedData

Available on crate feature vector2 only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Vector2>, <Self as TryInto<TimeDataMap<Vector2>>>::Error>

Performs the conversion.

impl TryInto<TimeDataMap<Vector2Vec>> for AnimatedData

Available on crate features vector2 and vec_variants only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Vector2Vec>, <Self as TryInto<TimeDataMap<Vector2Vec>>>::Error>

Performs the conversion.

impl<T: Eq> Eq for TimeDataMap<T>

impl<T> StructuralPartialEq for TimeDataMap<T>

Auto Trait Implementations§

impl<T> Freeze for TimeDataMap<T>

impl<T> RefUnwindSafe for TimeDataMap<T>
where T: RefUnwindSafe,

impl<T> Send for TimeDataMap<T>
where T: Send,

impl<T> Sync for TimeDataMap<T>
where T: Sync,

impl<T> Unpin for TimeDataMap<T>

impl<T> UnwindSafe for TimeDataMap<T>
where T: RefUnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,