Class AnimationGraph

The Animation Graph is used to evaluate a final pose for the animated model for the current frame.

System.Object
Object
Asset
BinaryAsset
AnimationGraph
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public class AnimationGraph : BinaryAsset

Constructors

AnimationGraph()

Initializes a new instance of the AnimationGraph.

Declaration
public AnimationGraph()

Properties

BaseModel

Gets the base model asset used for the animation preview and the skeleton layout source.

Declaration
[Unmanaged]
public SkinnedModel BaseModel { get; }
Property Value
SkinnedModel

Methods

InitAsAnimation(SkinnedModel, Animation, Boolean, Boolean)

Initializes virtual Anim Graph to play a single animation.

Declaration
[Unmanaged]
public bool InitAsAnimation(SkinnedModel baseModel, Animation anim, bool loop = true, bool rootMotion = false)
Parameters
SkinnedModel baseModel

The base model asset.
Animation anim

The animation to play.
System.Boolean loop

True if play animation in a loop.
System.Boolean rootMotion

True if apply root motion. Otherwise it will be ignored.
Returns
System.Boolean

True if failed, otherwise false.

LoadSurface()

Tries to load surface graph from the asset.

Declaration
[Unmanaged]
public byte[] LoadSurface()
Returns
System.Byte[]

The surface data or empty if failed to load it.

SaveSurface(Byte[])

Updates the animation graph surface (save new one, discard cached data, reload asset).

Declaration
[Unmanaged]
public bool SaveSurface(byte[] data)
Parameters
System.Byte[] data

Stream with graph data.
Returns
System.Boolean

True if cannot save it, otherwise false.

Extension Methods