Class AnimGraphBase

The base class for Anim Graphs that supports nesting sub graphs.

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

Constructors

~AnimGraphBase()

Finalizes an instance of the AnimGraphBase class.

Declaration
public ~AnimGraphBase()

AnimGraphBase(AnimGraph* graph)

Declaration
protected AnimGraphBase(AnimGraph* graph)
Parameters
AnimGraph graph

Fields

_graph

Declaration
protected AnimGraph* _graph
Field Value
AnimGraph

_rootNode

Declaration
protected Node* _rootNode = nullptr
Field Value
Node

BucketsCountSelf

The amount of state buckets used by the this graph.

Declaration
public int32 BucketsCountSelf
Field Value
int32

BucketsCountTotal

The amount of state buckets used by this graph including all sub-graphs.

Declaration
public int32 BucketsCountTotal
Field Value
int32

BucketsStart

The zero-based index of the bucket used by this graph. Valid only if BucketsCountSelf is non zero.

Declaration
public int32 BucketsStart
Field Value
int32

StateTransitions

The state transitions cached per-graph (that is a state machine).

Declaration
public Array<AnimGraphStateTransition> StateTransitions
Field Value
Array<AnimGraphStateTransition>

SubGraphs

The sub graphs nested in this graph.

Declaration
public Array<AnimSubGraph* , InlinedAllocation<32>> SubGraphs
Field Value
Array<AnimSubGraph , InlinedAllocation<32>>

Methods

Clear()

Clear whole graph data

Declaration
public virtual void Clear() override
Overrides

GetReferences(Array<Guid>& output)

Gets the asset references.

Declaration
public virtual void GetReferences(Array<Guid>& output) const override
Parameters
Array<Guid> assets

The output collection of the asset ids referenced by this object.
Overrides

GetRootNode()

Gets the root node of the graph (cache don load).

Declaration
public Node* GetRootNode() const
Returns
Node

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

LoadSubGraph(const void* data, int32 dataLength, const Char* name)

Loads the sub-graph.

Declaration
public AnimSubGraph* LoadSubGraph(const void* data, int32 dataLength, const Char* name)
Parameters
void data

The surface data.
int32 dataLength

The length of the data (in bytes).
Char name

The name of the sub-graph (optional). Used in error message logs.
Returns
AnimSubGraph

The loaded sub graph or null if there is no surface to load or if loading failed.

onNodeLoaded(Node* n)

Declaration
protected virtual bool onNodeLoaded(Node* n) override
Parameters
Node n

Returns
bool

Overrides

See Also