[−][src]Crate amethyst_animation
Provides computer graphics animation functionality.
Animation on a single entity comprises of one or more Samplers. Each sampler
operates on a Channel. Thus, for a single entity, conceptually each
(Channel, Sampler) pair is enough to define one part the animation, and a
Vec<(Channel, Sampler)> defines the whole animation.
In a more complex situation, an object in game may be made up of multiple entities. Say you have
a dragon monster, that is defined by a skinned mesh that has a skeleton with 10 joints. Each
joint will then be an Entity. Our animation definition holds the samplers to run for the whole
object. To animate each of the entities of this complex object, we need a way to link the
sampler to the each of the entities.
Animation definitions are persistent and can be stored on disk. Entities however, are not. To
link the right sampler to the right entity, when we construct each of the entities such as the
joints, we track it with an index, called the node_index.
The following list might help to illustrate the scenario:
| node index | entity |
|---|---|
| 0 | body ("main" entity) |
| 1 | head |
| 2 | left left |
| 3 | right left |
| ... | ... |
The node index to Entity mapping is stored in AnimationHierarchy.
Back to the animation definition, we also record the node_index in the tuple, which we call a
"node". Each node is now (node_index, Channel, Sampler) (conceptually — in code the
tuple holds references instead of the complete object). Hence, each node holds the information
of what channel the sampler belongs to, and which entity it should be applied to.
So what happens for the nodes where we only have one entity? Right now Amethyst requires you to
assign it node index 0.
Examples
The animation and gltf examples demonstrate usage of this crate.
Structs
| AnimatablePrefab |
|
| Animation | Defines a single animation. |
| AnimationBundle | Bundle for a complete animation setup including sampler interpolation and animation control. |
| AnimationControl | Controls the state of a single running animation on a specific component type |
| AnimationControlSet | Contains all currently running animations for an entity. |
| AnimationControlSystem | System for setting up animations, should run before |
| AnimationHierarchy | 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. |
| AnimationHierarchyPrefab |
|
| AnimationPrefab |
|
| AnimationSet | Attaches to an entity that have animations, with links to all animations that can be run on the entity. Is not used directly by the animation systems, provided for convenience. |
| AnimationSetPrefab |
|
| Joint | Joint, attach to an entity with a |
| JointPrefab |
|
| RestState | Define the rest state for a component on an entity |
| Sampler | Sampler defines a single animation for a single channel on a single component |
| SamplerControl | Control a single active sampler |
| SamplerControlSet | Sampler control set, containing a set of sampler controllers for a single component. |
| SamplerInterpolationSystem | System for interpolating active samplers. |
| SamplingBundle | Bundle for only the sampler interpolation. |
| Skin | Skin, attach to the root entity in the mesh hierarchy |
| SkinPrefab |
|
| SkinnablePrefab |
|
| VertexSkinningBundle | Bundle for vertex skinning |
| VertexSkinningSystem | System for performing vertex skinning. |
Enums
| AnimationCommand | Animation command |
| BlendMethod | Blend method for sampler blending |
| ControlState | State of animation |
| DeferStartRelation | Defer the start of an animation until the relationship has done this |
| EndControl | Control handling of animation/sampler end |
| InterpolationFunction | Supported interpolation functions |
| MaterialChannel | Channels that are animatable on |
| MaterialPrimitive | Sampler primitive for Material animations
Note that material can only ever be animated with |
| SamplerPrimitive | Sampler primitive |
| SpriteRenderChannel | Channels that are animatable on |
| SpriteRenderPrimitive | Sampler primitive for SpriteRender animations
Note that sprites can only ever be animated with |
| StepDirection | Used when doing animation stepping (i.e only move forward/backward to discrete input values) |
| TransformChannel | Channels that can be animated on |
Traits
| AnimationSampling | Master trait used to define animation sampling on a component |
| ApplyData | Extra data to extract from |
| InterpolationPrimitive | Interpolation primitive, defines basic arithmetic needed for interpolation. |
Functions
| get_animation_set | Get the animation set for an entity. If none exists, one will be added. If entity is invalid, (eg. removed before) None will be returned. |
Type Definitions
| AnimationProcessor | Asset storage processor for |
| SamplerProcessor | Asset storage processor for |