Animation

Description

Animation clips, skeletal and blend shape animation, animation playback, blending and other features.

Classes

struct  AnimationClipState
 Contains information about a currently playing animation clip. More...
 
struct  AnimationClipInfo
 Internal information about a single playing animation clip within Animation. More...
 
struct  BlendClipInfo
 Represents an animation clip used in 1D blending. More...
 
struct  Blend1DInfo
 Defines a 1D blend where multiple animation clips are blended between each other using linear interpolation. More...
 
struct  Blend2DInfo
 Defines a 2D blend where two animation clips are blended between each other using bilinear interpolation. More...
 
struct  AnimatedSceneObject
 Contains a mapping between a scene object and an animation curve it is animated with. More...
 
struct  MorphChannelInfo
 Information about a set of morph shapes blended sequentially. More...
 
struct  MorphShapeInfo
 Morph shape and its contribution to the final shape. More...
 
struct  AnimatedSceneObjectInfo
 Contains information about a scene object that is animated by a specific animation curve. More...
 
struct  AnimationProxy
 Represents a copy of the Animation data for use specifically on the animation thread. More...
 
class  Animation
 Handles animation playback. More...
 
struct  TKeyframe< T >
 Animation keyframe, represented as an endpoint of a cubic hermite spline. More...
 
class  TAnimationCurve< T >
 Animation spline represented by a set of keyframes, each representing an endpoint of a cubic hermite curve. More...
 
struct  TNamedAnimationCurve< T >
 An animation curve and its name. More...
 
struct  RendererAnimationData::PoseInfo
 Contains meta-data about a calculated skeleton pose. More...
 
struct  RendererAnimationData::MorphShapeInfo
 Contains data about a calculated morph shape. More...
 
struct  RendererAnimationData::AnimInfo
 Contains meta-data about where calculated animation data is stored. More...
 
struct  RendererAnimationData
 Contains skeleton poses for all animations evaluated on a single frame. More...
 
class  AnimationManager
 Keeps track of all active animations, queues animation thread tasks and synchronizes data between simulation, core and animation threads. More...
 
struct  TCurveCache< T >
 Holds cached information used for animation curve evaluation so that sequential evaluations can be sped up. More...
 
struct  MorphVertex
 A single vertex used for morph target animation. More...
 
class  MorphShape
 A set of vertices representing a single shape in a morph target animation. More...
 
class  MorphChannel
 A collection of morph shapes that are sequentially blended together. More...
 
class  MorphShapes
 Contains a set of morph channels used for morph target animation. More...
 
struct  AnimationCurveMapping
 Contains indices for position/rotation/scale animation curves. More...
 
struct  BONE_DESC
 Information about a single bone used for constructing a skeleton. More...
 
struct  AnimationState
 Contains information about a single playing animation clip. More...
 
struct  AnimationStateLayer
 Contains animation states for a single animation layer. More...
 
struct  LocalSkeletonPose
 Contains local translation, rotation and scale values for each bone in a skeleton, after being evaluated at a specific time of an animation. More...
 
struct  SkeletonBoneInfo
 Contains internal information about a single bone in a Skeleton. More...
 
class  Skeleton
 Contains information about bones required for skeletal animation. More...
 

Typedefs

typedef Flags< AnimDirtyStateFlag > AnimDirtyState
 
typedef Flags< AnimationCurveFlag > AnimationCurveFlags
 

Enumerations

enum  AnimWrapMode { Loop, Clamp }
 Determines how an animation clip behaves when it reaches the end. More...
 
enum  AnimDirtyStateFlag {
  Clean = 0, Value = 1 << 0, Layout = 1 << 1, All = 1 << 2,
  Culling = 1 << 3, MorphWeights = 1 << 4
}
 Flags that determine which portion of Animation was changed and needs to be updated. More...
 
enum  AnimPlaybackType { Normal, Sampled, None }
 Type of playback for animation clips. More...
 
enum  AnimationCurveFlag { ImportedCurve = 1 << 0, MorphFrame = 1 << 1, MorphWeight = 1 << 2 }
 Flags that described an TAnimationCurve<T>. More...
 

Functions

 BS_FLAGS_OPERATORS (AnimationCurveFlag)
 
BS_CORE_EXPORT AnimationManager & gAnimation ()
 Provides easier access to AnimationManager. More...
 

Enumeration Type Documentation

enum AnimationCurveFlag
strong

Flags that described an TAnimationCurve<T>.

Enumerator
ImportedCurve 

Signifies that the curve was imported from an external file, and not created manually in-engine.

MorphFrame 

Signifies the curve is used to animate between different frames within a morph channel.

In range [0, 1].

MorphWeight 

Signifies the curve is used to adjust the weight of a morph channel.

In range [0, 1].

enum AnimDirtyStateFlag
strong

Flags that determine which portion of Animation was changed and needs to be updated.

enum AnimPlaybackType
strong

Type of playback for animation clips.

Enumerator
Normal 

Play back the animation normally by advancing time.

Sampled 

Sample only a single frame from the animation.

None 

Do not play the animation.

enum AnimWrapMode
strong

Determines how an animation clip behaves when it reaches the end.

Enumerator
Loop 

Loop around to the beginning/end when the last/first frame is reached.

Clamp 

Clamp to end/beginning, keeping the last/first frame active.

Function Documentation

BS_CORE_EXPORT AnimationManager& bs::gAnimation ( )

Provides easier access to AnimationManager.