Banshee Engine Docs

Animation

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

Classes

  • AnimationClip — Contains animation curves for translation/rotation/scale of scene objects/skeleton bones, as well as curves for generic property animation.
  • AnimationUtility — Helper class for dealing with animations, animation clips and curves.
  • MorphShape — Name and weight of a single shape in a morph target animation.
  • MorphChannel — A collection of morph shapes that are sequentially blended together.
  • MorphShapes — Contains a set of morph channels used for morph target animation.
  • Skeleton — Contains information about bones required for skeletal animation.
  • SkeletonMask — Contains a bitfield that determines which skeleton bones are enabled or disabled during skeletal animation.
  • SkeletonMaskBuilder — Builds a SkeletonMask for a specific skeleton.
  • Animation — Handles animation playback.
  • Bone — Component that maps animation for specific bone also be applied to the SceneObject this component is attached to.

Structs

  • AnimationCurves — A set of animation curves representing translation/rotation/scale and generic animation.
  • RootMotion — Contains a set of animation curves used for moving and rotating the root bone.
  • AnimationEvent — Event that is triggered when animation reaches a certain point.
  • TCurveProperties — Contains information and helper methods for various curve types.
  • KeyframeRef
  • TangentRef — Structure containing a reference to a keyframe tangent, as a keyframe reference and type of the tangent.
  • MorphVertex — A single vertex used for morph target animation.
  • AnimationCurveMapping — Contains indices for position/rotation/scale animation curves.
  • BoneInformation — Information about a single bone used for constructing a skeleton.
  • AnimationState — Contains information about a single playing animation clip.
  • AnimationStateLayer — Contains animation states for a single animation layer.
  • LocalSkeletonPose — Contains local translation, rotation and scale values for each bone in a skeleton, after being evaluated at a specific time of an animation.
  • SkeletonBoneInfo — Contains internal information about a single bone in a Skeleton.
  • AnimationClipState — Contains information about a currently playing animation clip.
  • BlendClipInfo — Represents an animation clip used in 1D blending.
  • Blend1DInfo — Defines a 1D blend where multiple animation clips are blended between each other using linear interpolation.
  • Blend2DInfo — Defines a 2D blend where two animation clips are blended between each other using bilinear interpolation.

Enums

Internal

Symbols intended for engine-internal use. Not part of the public API.

Classes

  • TAnimationCurve — Animation spline represented by a set of keyframes, each representing an endpoint of a cubic hermite curve.
  • AnimationScene — Keeps track of all active animations in a single scene instance.

Structs

  • Animation::SceneObjectMappingInfo — Information about scene objects bound to a specific animation curve.
  • TCurveCache — Holds cached information used for animation curve evaluation so that sequential evaluations can be sped up.
  • TCurveIntegrationCache — Holds cached information used for integrated animation curve evaluation.
  • TKeyframe — Animation keyframe, represented as an endpoint of a cubic hermite spline.
  • TNamedAnimationCurve — An animation curve and its name.
  • EvaluatedAnimationData — Contains skeleton poses for all animations evaluated on a single frame.
  • EvaluatedAnimationData::PoseInfo — Contains meta-data about a calculated skeleton pose.
  • EvaluatedAnimationData::MorphShapeInfo — Contains data about a calculated morph shape.
  • EvaluatedAnimationData::AnimationInfo — Contains meta-data about where calculated animation data is stored.
  • AnimationClipInfo — Internal information about a single playing animation clip within Animation.
  • SceneObjectMappingCurveInfo — Contains a mapping between a scene object and an animation curve it is animated with.
  • MorphChannelInfo — Information about a set of morph shapes blended sequentially.
  • MorphShapeInfo — Morph shape and its contribution to the final shape.
  • AnimatedSceneObjectInfo — Contains information about a scene object that is animated by a specific animation curve.
  • AnimationProxy — Represents a copy of the Animation data for use specifically on the animation thread.

Enums