Struct amethyst_animation::AnimationHierarchy

pub struct AnimationHierarchy<T> {
    pub nodes: FnvHashMap<usize, Entity>,
    // some fields omitted
}

Defines the hierarchy of nodes that a single animation can control. Attached to the root entity that an animation can be defined for. Only required for animations which target more than a single node or entity.

Fields

nodes: FnvHashMap<usize, Entity>

A mapping between indices and entities

Methods

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

pub fn new() -> Self

Create a new hierarchy

pub fn new_single(index: usize, entity: Entity) -> Self

Create a new hierarchy containing a single given entity

pub fn new_many(nodes: FnvHashMap<usize, Entity>) -> Self

Create a new hierarchy with the given entity map

pub fn rest_state<F>(
    &self,
    get_component: F,
    states: &mut WriteStorage<RestState<T>>
) where
    T: AnimationSampling + Clone,
    F: Fn(Entity) -> Option<T>, 

Create rest state for the hierarchy. Will copy the values from the base components for each entity in the hierarchy.

Trait Implementations

impl<T> Default for AnimationHierarchy<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Clone> Clone for AnimationHierarchy<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for AnimationHierarchy<T>

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

Formats the value using the given formatter.

impl<T> Component for AnimationHierarchy<T> where
    T: AnimationSampling, 

type Storage = DenseVecStorage<Self>

Associated storage type for this component.