Navigation
API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/DecoratorBase
References
| Module | AnimNext |
| Header | /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/ExecutionContext.h |
| Include | #include "DecoratorBase/ExecutionContext.h" |
Syntax
struct FExecutionContext
Remarks
Execution Context
The execution context aims to centralize the decorator query API. It is meant to be bound to a graph instance and re-used by the nodes/decorators within.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Creates an unbound execution context. | ||
 |
FExecutionContext
(
FAnimNextGraphInstancePtr& InGraphInstance |
Creates an execution context and binds it to the specified graph instance. | |
 |
FExecutionContext
(
FAnimNextGraphInstance& InGraphInstance |
Creates an execution context and binds it to the specified graph instance. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FDecoratorPtr | AllocateNodeInstance
(
const FDecoratorBinding& ParentBinding, |
Allocates a new node instance from a decorator handle If the desired decorator lives in the current parent, a weak handle to it will be returned |
  |
FDecoratorPtr | AllocateNodeInstance
(
const FWeakDecoratorPtr& ParentBinding, |
Allocates a new node instance from a decorator handle If the desired decorator lives in the current parent, a weak handle to it will be returned |
 |
void | BindTo
(
const FWeakDecoratorPtr& DecoratorPtr |
Binds the execution context to the graph instance that owns the specified decorator if it differs from the currently bound instance. |
 |
void | BindTo
(
FAnimNextGraphInstance& InGraphInstance |
Binds the execution context to the specified graph instance if it differs from the currently bound instance. |
 |
void | BindTo
(
FAnimNextGraphInstancePtr& InGraphInstance |
Binds the execution context to the specified graph instance if it differs from the currently bound 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. | |
  |
FAnimNextGraphInstance & | Returns the bound graph instance. | |
  |
bool | GetInterface
(
const FWeakDecoratorPtr& DecoratorPtr, |
If no such decorator exists, nullptr is returned. |
  |
bool | GetInterface
(
const FDecoratorBinding& Binding, |
If no such decorator exists, nullptr is returned. |
  |
bool | GetInterfaceSuper
(
const FWeakDecoratorPtr& DecoratorPtr, |
If no such decorator exists, nullptr is returned. |
  |
bool | GetInterfaceSuper
(
const FDecoratorBinding& Binding, |
If no such decorator exists, nullptr is returned. |
  |
bool | IsBound () |
Returns whether or not this execution context is bound to a graph instance. |
  |
bool | IsBoundTo
(
const FAnimNextGraphInstance& InGraphInstance |
Returns whether or not this execution context is bound to the specified graph instance. |
  |
bool | IsBoundTo
(
const FAnimNextGraphInstancePtr& InGraphInstance |
Returns whether or not this execution context is bound to the specified graph instance. |
  |
void | ReleaseNodeInstance
(
FDecoratorPtr& NodePtr |
Decrements the reference count of the provided node pointer and releases it if there are no more references remaining, reseting the pointer in the process |
  |
void | SnapshotLatentProperties
(
const FWeakDecoratorPtr& DecoratorPtr, |
Takes a snapshot of all latent properties on the provided node sub-stack (all decorators on the sub-stack of the provided one) Properties can be marked as always updating or as supporting freezing (e.g. when a branch of the graph blends out) A freezable property does not update when a snapshot is taken of a frozen node |
  |
ComponentType * | Returns a typed graph instance component pointer if found or nullptr otherwise. |