Navigation
API > API/Plugins > API/Plugins/RigLogicAnimNext
Inheritance Hierarchy
- FBaseTrait
- IEvaluate
- IUpdate
- IUpdateTraversal
- IHierarchy
- FRigLogicTrait
References
| Module | RigLogicAnimNext |
| Header | /Engine/Plugins/Experimental/RigLogicAnimNext/Source/RigLogicAnimNext/Public/RigLogicTrait.h |
| Include | #include "RigLogicTrait.h" |
Syntax
struct FRigLogicTrait :
public UE::AnimNext::FBaseTrait ,
public UE::AnimNext::IEvaluate ,
public UE::AnimNext::IUpdate ,
public UE::AnimNext::IUpdateTraversal ,
public UE::AnimNext::IHierarchy
Remarks
A trait that can run RigLogic.
Overridden from FTrait
| Type | Name | Description | |
|---|---|---|---|
| void | ConstructTraitInstance
(
const UE::AnimNext::FExecutionContext& Context, |
Called when a new instance of the trait is created or destroyed Derived types must override this and forward to the instance data constructor/destructor | |
| void | DestructTraitInstance
(
const UE::AnimNext::FExecutionContext& Context, |
||
| FTraitLatentPropertyMemoryLayout | GetLatentPropertyMemoryLayout
(
FName PropertyName, |
Returns the memory layout of the specified latent property. | |
| uint32 | The number of latent property properties in the shared data of this trait. | ||
| TConstArrayView< FTraitEventUID > | Returns a list of events that this trait handles. | ||
| const UE::AnimNext::ITraitInterface * | GetTraitInterface
(
UE::AnimNext::FTraitInterfaceUID InterfaceUID |
Returns a pointer to the specified interface if it is supported. Derived types must override this. | |
| TConstArrayView< FTraitInterfaceUID > | Returns a list of interfaces that this trait supports. | ||
| UE::AnimNext::FTraitMemoryLayout | Returns the memory requirements of the derived trait instance. | ||
| FString | GetTraitName () |
Returns the trait name. | |
| TConstArrayView< FTraitInterfaceUID > | Returns a list of interfaces that this trait reqquires. | ||
| UScriptStruct * | Returns the UScriptStruct associated with the shared data for the trait. | ||
| UE::AnimNext::FTraitUID | GetTraitUID () |
Returns the globally unique UID for this trait. | |
| UE::AnimNext::ETraitStackPropagation | OnTraitEvent
(
UE::AnimNext::FExecutionContext& Context, |
Called when an event reaches an instance of this trait. |
Overridden from IEvaluate
| Type | Name | Description | |
|---|---|---|---|
| void | PostEvaluate
(
FEvaluateTraversalContext& Context, |
IEvaluate impl. |
Overridden from IUpdate
| Type | Name | Description | |
|---|---|---|---|
| void | OnBecomeRelevant
(
FUpdateTraversalContext& Context, |
IUpdate impl Called before the first update when a trait stack becomes relevant |
Overridden from IUpdateTraversal
| Type | Name | Description | |
|---|---|---|---|
| void | QueueChildrenForTraversal
(
FUpdateTraversalContext& Context, |
IUpdateTraversal impl. |
Overridden from IHierarchy
| Type | Name | Description | |
|---|---|---|---|
| void | GetChildren
(
const FExecutionContext& Context, |
Appends weak handles to any children we wish to traverse on the trait implementation (not the whole stack). | |
| uint32 | GetNumChildren
(
const FExecutionContext& Context, |
IHierarchy impl. |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FInstanceData | Do we need this? Or is the input in the shared data sufficient? |
Typedefs
| Name | Description |
|---|---|
| FSharedData | |
| TraitSuper |
Constants
| Name | Description |
|---|---|
| TraitMemoryDescription | |
| TraitUID | FTrait impl |