Enum Value 

pub enum Value {
    Uniform(Data),
    Animated(AnimatedData),
}

A value that can be either uniform or animated over time.

A Value contains either a single Data value that remains constant (uniform) or AnimatedData that changes over time with interpolation.

Variants

Uniform(Data)

A constant value that does not change over time.

Animated(AnimatedData)

A value that changes over time with keyframe interpolation.

Implementations

impl Value

pub fn uniform<V: Into<Data>>(value: V) -> Self

Create a uniform value that does not change over time.

pub fn animated<I, V>(samples: I) -> Result<Self>

where I: IntoIterator<Item = (Time, V)>, V: Into<Data>,

Create an animated value from time-value pairs.

All samples must have the same data type. Vector samples are padded to match the length of the longest vector in the set.

pub fn add_sample<V: Into<Data>>(&mut self, time: Time, val: V) -> Result<()>

Add a sample at a specific time, checking length constraints

pub fn remove_sample(&mut self, time: &Time) -> Option<Data>

Remove a sample at a specific time.

Returns the removed value if it existed. For uniform values, this is a no-op and returns None. The last sample in an animated value cannot be removed (returns None). Use remove_or_make_uniform to degrade to uniform instead.

pub fn remove_or_make_uniform(&mut self, time: &Time) -> Option<Data>

Remove a sample, converting to uniform if it was the last keyframe.

If the value is uniform, returns None. If the removed sample was the last keyframe, the value degrades from Value::Animated to Value::Uniform with that keyframe’s value and returns None (the data is preserved, not lost). Otherwise returns the removed value.

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

Sample value at exact time without interpolation.

Returns the exact value if it exists at the given time, or None if no sample exists at that time for animated values.

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

Get the value at or before the given time

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

Get the value at or after the given time

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

Interpolate value at the given time.

For uniform values, returns the constant value. For animated values, interpolates between surrounding keyframes using appropriate interpolation methods (linear, quadratic, or hermite).

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

Get surrounding samples for interpolation.

pub fn sample_bracket( &self, time: Time, ) -> (Option<(Time, Data)>, Option<(Time, Data)>)

Get the two samples surrounding a time for linear interpolation

pub fn is_animated(&self) -> bool

Check if the value is animated.

pub fn sample_count(&self) -> usize

Get the number of time samples.

pub fn times(&self) -> SmallVec<[Time; 10]>

Get all time samples.

pub fn merge_with<F>(&self, other: &Value, combiner: F) -> Result<Value>

where F: Fn(&Data, &Data) -> Data,

Merge this value with another using a combiner function.

For uniform values, applies the combiner once. For animated values, samples both at the union of all keyframe times and applies the combiner at each time.

Example

// Multiply two matrices
let result = matrix1.merge_with(&matrix2, |a, b| {
    match (a, b) {
        (Data::Matrix3(m1), Data::Matrix3(m2)) => {
            Data::Matrix3(Matrix3(m1.0 * m2.0))
        }
        _ => a, // fallback
    }
})?;

impl Value

pub fn hash_with_shutter<H: Hasher>(&self, state: &mut H, shutter: &Shutter)

Hash the value with shutter context for animation-aware caching.

For animated values, this samples at standardized points within the shutter range and hashes the interpolated values rather than raw keyframes. This provides better cache coherency for animations with different absolute times but identical interpolated values.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataTypeOps for Value

Available on crate feature builtin-types only.

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 Debug for Value

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

Formats the value using the given formatter.

impl<V: Into<Data>> From<V> for Value

fn from(value: V) -> Self

Converts to this type from the input type.

impl Hash for Value

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

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

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 Value

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

Generate samples across the shutter interval.

impl Sample<Integer> for Value

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

Generate samples across the shutter interval.

impl Sample<Matrix3> for Value

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

Generate samples across the shutter interval.

impl Sample<Real> for Value

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

Generate samples across the shutter interval.

impl Sample<Vector2> for Value

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

Generate samples across the shutter interval.

impl TryFrom<&Value> for Boolean

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for BooleanVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Color

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for ColorCurve

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for ColorVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Integer

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for IntegerVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Matrix3

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Matrix3Vec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Real

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for RealCurve

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for RealVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for StringVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Vector2

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Vector2Vec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Boolean

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for BooleanVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Color

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for ColorCurve

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for ColorVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Integer

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for IntegerVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Matrix3

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Matrix3Vec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Real

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for RealCurve

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for RealVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for StringVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Vector2

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Vector2Vec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Value

impl StructuralPartialEq for Value