Struct AnimationData

Skeleton nodes animation data container. Includes metadata about animation sampling, duration and node animations curves.

Assembly: FlaxEngine.dll

File: Engine/Animations/AnimationData.h

Syntax

public struct AnimationData

Fields

Channels

The per-skeleton node animation channels.

Declaration

public Array<NodeAnimationData> Channels

Field Value

Array<NodeAnimationData>

Duration

The duration of the animation (in frames).

Declaration

public double Duration = 0.0

Field Value

double

Events

The animation event tracks.

Declaration

public Array<Pair<String, StepCurve<EventAnimationData>>> Events

Field Value

Array<Pair<String, StepCurve<EventAnimationData>>>

FramesPerSecond

The amount of the animation frames per second.

Declaration

public double FramesPerSecond = 0.0

Field Value

double

Name

The animation name.

Declaration

public String Name

Field Value

String

RootMotionFlags

Enables root motion extraction support from this animation.

Declaration

public AnimationRootMotionFlags RootMotionFlags = AnimationRootMotionFlags::None

Field Value

AnimationRootMotionFlags

RootNodeName

The custom node name to be used as a root motion source. If not specified the actual root node will be used.

Declaration

public String RootNodeName

Field Value

String

Methods

GetChannel(const StringView& name)

Declaration

public NodeAnimationData* GetChannel(const StringView& name)

Parameters

StringView name

Returns

NodeAnimationData

GetKeyframesCount()

Gets the total amount of keyframes in the all animation channels.

Declaration

public int32 GetKeyframesCount() const

Returns

int32

GetLength()

Gets the length of the animation (in seconds).

Declaration

public float GetLength() const

Returns

float

GetMemoryUsage()

Declaration

public uint64 GetMemoryUsage() const

Returns

uint64

Release()

Releases data.

Declaration

public void Release()

Swap(AnimationData& other)

Swaps the contents of object with the other object without copy operation. Performs fast internal data exchange.

Declaration

public void Swap(AnimationData& other)

Parameters

AnimationData other The other object.