Navigation
API > API/Plugins > API/Plugins/AnimNextAnimGraph
Node Handle A node handle represents a reference to a specific node instance in the shared/read-only portion of a sub-graph. It points to a FNodeDescription when resolved.
Internally, it contains either a shared data offset into the parent graph (at runtime) or a FNodeID (during compilation and on disk). Shared offsets must be computed at runtime and as such we use the FNodeID to resolve into our final offset on load. We only use the bottom 24 bits. If the LSB is 0, the packed value represents a shared offset (due to alignment) but if the LSB is 1, the packed value represents a node ID shifted left by 1.
| Name | FNodeHandle |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/AnimNextAnimGraph/Source/AnimNextAnimGraph/Public/TraitCore/NodeHandle.h |
| Include Path | #include "TraitCore/NodeHandle.h" |
Syntax
struct FNodeHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
constexpr FNodeHandle () |
Creates an invalid node handle. | TraitCore/NodeHandle.h | |
constexpr FNodeHandle
(
uint32 PackedValue |
TraitCore/NodeHandle.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| INVALID_NODE_HANDLE_RAW_VALUE | uint32 | We pack the shared offset on 24 bits, the top 8 bits are unused and they can have any value (zero by default) | TraitCore/NodeHandle.h |
| NODE_HANDLE_MASK | uint32 | TraitCore/NodeHandle.h | |
| NODE_ID_MARKER_BIT_MASK | uint32 | TraitCore/NodeHandle.h | |
| NODE_ID_SHIFT | uint32 | TraitCore/NodeHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FAnimNextEntryPointHandle | friend | TraitCore/NodeHandle.h | ||
| FAnimNextTraitHandle | friend | TraitCore/NodeHandle.h | ||
| PackedSharedOffsetOrID | uint32 | TraitCore/NodeHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNodeID GetNodeID() |
Returns the node ID encoded by the handle. | TraitCore/NodeHandle.h | |
uint32 GetSharedOffset() |
Returns the offset into the shared data relative to the root of the owning sub-graph. | TraitCore/NodeHandle.h | |
bool IsNodeID() |
Returns whether this node handle encodes a node ID or not. | TraitCore/NodeHandle.h | |
bool IsSharedOffset() |
Returns whether this node handle encodes a shared offset or not. | TraitCore/NodeHandle.h | |
bool IsValid() |
Returns true if this node handle is valid, false otherwise. | TraitCore/NodeHandle.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FNodeHandle FromNodeID
(
FNodeID NodeID |
Creates a node handle from a node ID. | TraitCore/NodeHandle.h | |
static FNodeHandle FromPackedValue
(
uint32 PackedValue |
Creates a node handle from a raw packed value. | TraitCore/NodeHandle.h | |
static FNodeHandle FromSharedOffset
(
uint32 SharedOffset |
Creates a node handle for the specified shared offset. | TraitCore/NodeHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
FNodeHandle RHS |
TraitCore/NodeHandle.h | ||
bool operator==
(
FNodeHandle RHS |
Equality and inequality tests. | TraitCore/NodeHandle.h |