Navigation
API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/Graph
References
| Module | AnimNext |
| Header | /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/Graph/AnimNextGraphInstance.h |
| Include | #include "Graph/AnimNextGraphInstance.h" |
Syntax
USTRUCT ()
struct FAnimNextGraphInstance
Remarks
Represents an instance of an AnimNext graph This struct uses UE reflection because we wish for the GC to keep the graph alive while we own a reference to it. It is not intended to be serialized on disk with a live instance.
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Creates an empty graph instance that doesn't reference anything. | |||
FAnimNextGraphInstance
(
const FAnimNextGraphInstance& |
No copying, no moving. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
| If the graph instance is allocated, we release it during destruction. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddStructReferencedObjects
(
FReferenceCollector& Collector |
Adds strong/hard object references during GC. | |
| ComponentType & | GetComponent () |
Returns a typed graph instance component, creating it lazily the first time it is queried. | |
| GraphInstanceComponentMapType::TConstIterator | Returns const iterators to the graph instance component container. | ||
| FName | Returns the entry point in Graph that this instance corresponds to. | ||
| const UAnimNextGraph * | GetGraph () |
Returns the graph used by this instance or nullptr if the instance is invalid. | |
| UE::AnimNext::FWeakDecoratorPtr | Returns a weak handle to the root decorator instance. | ||
| FAnimNextGraphInstance * | Returns the parent graph instance that owns us or nullptr for the root graph instance or if we are invalid. | ||
| FAnimNextGraphInstance * | Returns the root graph instance that owns us and the components or nullptr if we are invalid. | ||
| bool | IsRoot () |
Returns whether or not this graph instance is the root graph instance or false otherwise. | |
| bool | IsValid () |
Returns true if we have a live graph instance, false otherwise. | |
| void | Release () |
Releases the graph instance and frees all corresponding memory. | |
| ComponentType * | Returns a typed graph instance component pointer if found or nullptr otherwise. | ||
| const ComponentType * | Returns a typed graph instance component pointer if found or nullptr otherwise. | ||
| bool | UsesEntryPoint
(
FName InEntryPoint |
Check to see if this instance data matches the provided graph entry point. | |
| bool | UsesGraph
(
const UAnimNextGraph* InGraph |
Check to see if this instance data matches the provided graph. |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FAnimNextGraphInstance & | operator=
(
const FAnimNextGraphInstance& |