Struct amethyst_animation::Animation

pub struct Animation<T> where
    T: AnimationSampling,  {
    pub nodes: Vec<(usize, T::Channel, Handle<Sampler<T::Primitive>>)>,
}

Defines a single animation.

An animation is a set of Samplers that should always run together as a unit.

Defines relationships between the node index in AnimationHierarchy and a Sampler handle. If the animation only targets a single node index, AnimationHierarchy is not required.

Type parameters:

• T: the component type that the animation should be applied to

Fields

nodes: Vec<(usize, T::Channel, Handle<Sampler<T::Primitive>>)>

node index -> sampler handle

Methods

impl<T> Animation<T> where
    T: AnimationSampling, 

pub fn new() -> Self

Create new empty animation

pub fn new_single(
    index: usize,
    channel: T::Channel,
    sampler: Handle<Sampler<T::Primitive>>
) -> Self

Create an animation with a single sampler

pub fn add(
    &mut self,
    node_index: usize,
    channel: T::Channel,
    sampler: Handle<Sampler<T::Primitive>>
)

Add a sampler to the animation

pub fn with(
    self,
    node_index: usize,
    channel: T::Channel,
    sampler: Handle<Sampler<T::Primitive>>
) -> Self

Add a sampler to the animation

Trait Implementations

impl<T: Default> Default for Animation<T> where
    T: AnimationSampling,
    T::Channel: Default,
    T::Primitive: Default, 

fn default() -> Animation<T>

Returns the "default value" for a type.

impl<T: Clone> Clone for Animation<T> where
    T: AnimationSampling,
    T::Channel: Clone,
    T::Primitive: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Animation<T> where
    T: AnimationSampling,
    T::Channel: Debug,
    T::Primitive: Debug, 

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

Formats the value using the given formatter.

impl<T> Asset for Animation<T> where
    T: AnimationSampling, 

const NAME: &'static str

An identifier for this asset used for debugging.

type Data = Self

The Data type the asset can be created from.

type HandleStorage = VecStorage<Handle<Self>>

The ECS storage type to be used. You'll want to use DenseVecStorage in most cases.