Struct TrackDataContainer

pub struct TrackDataContainer {
    pub mode: InterpolationMode,
    /* private fields */
}

Container for a track data. Strictly speaking, it is just a set of parametric curves which can be fetched at a given time position simultaneously, producing a value of desired type. Which type of value is produced is defined by TrackValueKind enumeration. Usually a container contains up to 4 curves (the largest type supported is Vector4).

Each component is bound to a specific curve. For example, in case of Vector3 its components bound to the following curve indices: X = 0, Y = 1, Z = 2. This order cannot be changed.

Fields

mode: InterpolationMode

Interpolation mode.

Implementations

impl TrackDataContainer

pub const CURVES: &'static str = "curves"

pub const KIND: &'static str = "kind"

pub const MODE: &'static str = "mode"

impl TrackDataContainer

pub fn new(kind: TrackValueKind) -> TrackDataContainer

Creates a new container, that is able to produce values defined by TrackValueKind input parameter. The number of curves in the output container is defined by TrackValueKind::components_count, for example Vector3 has 3 components (X, Y, Z). An empty container can be created using Self::default method.

pub fn add_curve(&mut self, curve: Curve)

Adds a new curve to the container. Keep in mind, that the actual useful amount of curves has soft limit of four due to TrackValueKind, any excessive curves will be ignored.

pub fn curve(&self, index: usize) -> Option<&Curve>

Tries to borrow a curve at a given index.

pub fn curve_mut(&mut self, index: usize) -> Option<&mut Curve>

Tries to borrow a curve at a given index.

pub fn curves_ref(&self) -> &[Curve]

Returns a reference to curves container.

pub fn curves_mut(&mut self) -> &mut [Curve]

Tries to borrow a curve at a given index.

pub fn set_value_kind(&mut self, kind: TrackValueKind)

Sets new kind of output value. Keep in mind, that the curves will remain unchanged, if you need to re-use the container you might need to re-create/re-fill the curves too.

pub fn value_kind(&self) -> TrackValueKind

Returns the kind of output value produced by the container.

pub fn fetch(&self, time: f32) -> Option<TrackValue>

Tries to get a value at a given time. The method could fail if the internal set of curves is malformed and cannot produce a desired value (for example, Vector3 can be fetched only if the amount of curves is 3).

pub fn time_length(&self) -> f32

Find a right-most key on one of the curves in the container and returns its position. This position can be treated as a maximum “length” of the container.

Trait Implementations

impl Clone for TrackDataContainer

fn clone(&self) -> TrackDataContainer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrackDataContainer

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

Formats the value using the given formatter.

impl Default for TrackDataContainer

fn default() -> TrackDataContainer

Returns the “default value” for a type.

impl PartialEq for TrackDataContainer

fn eq(&self, other: &TrackDataContainer) -> 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 Reflect for TrackDataContainer

where TrackDataContainer: 'static, Vec<Curve>: Reflect, TrackValueKind: Reflect, InterpolationMode: Reflect,

fn source_path() -> &'static str

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

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

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

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<TrackDataContainer>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]), )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>), )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl Visit for TrackDataContainer

where Vec<Curve>: Visit, TrackValueKind: Visit, InterpolationMode: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl StructuralPartialEq for TrackDataContainer