Struct Animation

pub struct Animation {
    pub fps: f32,
    pub object_name: String,
    pub property_name: String,
    pub frame_start: u32,
    pub frame_end: u32,
    pub frame_values: Vec<f32>,
}

An animation for a single property of a single object.

Fields

fps: f32

The number of frames per second. Same as PropertiesAnimation::fps

object_name: String

The unique name of the object.

property_name: String

The name of the property.

frame_start: u32

The first frame of the animation.

frame_end: u32

The last frame of the animation (including).

frame_values: Vec<f32>

The list of values for each frame starting with frame_start and ending with frame_end.

Implementations

impl Animation

pub fn get_animation_value_at_time(&self, elapsed_time: f32) -> f32

Returns the value of the animation at the given time (in seconds).

pub fn get_value_at_exact_frame(&self, frame: u32) -> f32

Returns the value of the animation at the given frame. If a frame is before the start of the animation, the first value is returned. If a frame is after the end of the animation, the last value is returned.

pub fn get_interpolated_value_at_frame(&self, frame: f32) -> f32

Returns the value of the animation at the given frame. If a frame is before the start of the animation, the first value is returned. If a frame is after the end of the animation, the last value is returned. If a frame is between two frames (i.e. is not an integer), the value is linearly interpolated.

Trait Implementations

impl Clone for Animation

fn clone(&self) -> Animation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Animation

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

Formats the value using the given formatter.

impl PartialEq for Animation

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

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

const 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 StructuralPartialEq for Animation