Navigation
API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/Graph
References
| Module | AnimNext |
| Header | /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/Graph/AnimNextGraphInstancePtr.h |
| Include | #include "Graph/AnimNextGraphInstancePtr.h" |
Syntax
USTRUCT (BlueprintType , DisplayName="Animation Graph Instance")
struct FAnimNextGraphInstancePtr
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. |
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. |
  |
void | BindPublicVariables
(
TConstArrayView< UE::AnimNext::IDataInterfaceHost* > InHosts |
Bind the variables in the supplied traits in scope to their respective public variables. |
  |
const UAnimNextAnimationGraph * | Returns the animation graph that will be used by this instance. | |
 |
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. | |
  |
FRigVMExtendedExecuteContext & | Get the extended execute context that we own. | |
  |
UE::AnimNext::FWeakTraitPtr | Returns a weak handle to the root trait instance. | |
  |
FAnimNextGraphInstance * | GetImpl () |
Returns the graph instance implementation. |
  |
bool | HasUpdated () |
Returns whether or not this graph instance has updated at least once. |
  |
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. |
  |
bool | Whether public variables require a binding. | |
 |
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. | |
  |
void | Update () |
Called each time the graph updates. |
  |
bool | UsesAnimationGraph
(
const UAnimNextAnimationGraph* InAnimationGraph |
Check to see if this instance data matches the provided animation graph. |