Class AnimGraph

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

Assembly: FlaxEngine.dll
File: Engine/Animations/Graph/AnimGraph.h
Syntax
public class AnimGraph : public AnimGraphBase

Constructors

~AnimGraph()

Declaration
public ~AnimGraph()

AnimGraph(Asset* owner, bool isFunction=false)

Initializes a new instance of the AnimGraph class.

Declaration
public AnimGraph(Asset* owner, bool isFunction=false)
Parameters
Asset owner

The graph owning asset.
bool isFunction

True if the graph is Animation Graph Function, otherwise false.

Fields

BaseModel

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

Use for read-only as it's serialized from the one of the Graph parameters (see ANIM_GRAPH_PARAM_BASE_MODEL_ID);

Declaration
public AssetReference<SkinnedModel> BaseModel
Field Value
AssetReference<SkinnedModel>

Version

The Anim Graph data version number. Used to sync the Anim Graph data with the instances state. Handles Anim Graph reloads to ensure data is valid.

Declaration
public uint32 Version = 0
Field Value
uint32

Methods

IsReady()

Determines whether this graph is ready for the animation evaluation.

Declaration
public bool IsReady() const
Returns
bool

Load(ReadStream* stream, bool loadMeta)

Load graph from the stream

Declaration
public virtual bool Load(ReadStream* stream, bool loadMeta) override
Parameters
ReadStream stream

Input stream
bool loadMeta

True if load all saved metadata
Returns
bool

True if cannot load data, otherwise false
Overrides

onParamCreated(Parameter* p)

Declaration
public virtual bool onParamCreated(Parameter* p) override
Parameters
Parameter p

Returns
bool

Overrides