1. Epic GamesDeveloper
  3. FAnimNextGraphInstance

FAnimNextGraphInstance

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.

API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/Graph

Inheritance Hierarchy

References

   
Module AnimNext
Header /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/Graph/AnimNextGraphInstance.h
Include #include "Graph/AnimNextGraphInstance.h"

Syntax

USTRUCT ()  
struct FAnimNextGraphInstance : public FAnimNextDataInterfaceInstance

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
Public function   Creates an empty graph instance that doesn't reference anything.
Public function   No copying, no moving.

Destructors

  Type Name Description
Public function   If the graph instance is allocated, we release it during destruction.

Functions

  Type Name Description
Public function void Adds strong/hard object references during GC.
Public function Const const UAnimNextAnimationGraph * Returns the animation graph used by this instance or nullptr if the instance is invalid.
Public function ComponentType & Returns a typed graph instance component, creating it lazily the first time it is queried.
Public function Const GraphInstanceComponentMapType::TConstIterator Returns const iterators to the graph instance component container.
Public function Const FName Returns the entry point in Graph that this instance corresponds to.
Public function Const UE::AnimNext::FWeakTraitPtr Returns a weak handle to the root trait instance.
Public function Const FAnimNextDataInterfaceInstance *

GetHost ()

 Get the hosting instance, if any, that owns us.
Public function Const FAnimNextModuleInstance * Returns the module instance that owns us or nullptr if we are invalid.
Public function Const FAnimNextGraphInstance * Returns the parent graph instance that owns us or nullptr for the root graph instance or if we are invalid.
Public function Const FAnimNextGraphInstance * Returns the root graph instance that owns us and the components or nullptr if we are invalid.
Public function FInstancedPropertyBag &  
Public function Const bool Returns whether or not this graph instance has updated at least once.
Public function Const bool

IsRoot ()

 Returns whether or not this graph instance is the root graph instance or false otherwise.
Public function Const bool

IsValid ()

 Returns true if we have a live graph instance, false otherwise.
Public function void

Release ()

 Releases the graph instance and frees all corresponding memory.
Public function ComponentType * Returns a typed graph instance component pointer if found or nullptr otherwise.
Public function Const const ComponentType * Returns a typed graph instance component pointer if found or nullptr otherwise.
Public function void

Update ()

 Called each time the graph updates.
Public function Const bool

UsesAnimationGraph ( const UAnimNextAnimationGraph* InAnimationGraph
)

 Check to see if this instance data matches the provided animation graph.
Public function Const bool

UsesEntryPoint ( FName InEntryPoint
)

 Check to see if this instance data matches the provided graph entry point.

Operators

  Type Name Description
Public function FAnimNextGraphInstance &  

Enums

  Type Name Description
Private enum EPublicVariablesState The current state of public variable bindings to the host.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page