Navigation
API > API/Plugins > API/Plugins/ControlRig
| Name | FControlRigExecuteContext |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/RigUnitContext.h |
| Include Path | #include "Units/RigUnitContext.h" |
Syntax
USTRUCT (BlueprintType )
struct FControlRigExecuteContext : public FRigVMExecuteContext
Inheritance Hierarchy
- FRigVMExecuteContextFixLayout → FRigVMExecutePin → FRigVMExecuteContext → FControlRigExecuteContext
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FControlRigExecuteContext() |
Units/RigUnitContext.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnAddShapeLibrary | TBaseDelegate_FourParams< void, const FControlRigExecuteContext *InContext, const FString &, UControlRigShapeLibrary *, bool > | Units/RigUnitContext.h | |
| FOnShapeExists | TBaseDelegate_OneParam< bool, const FName & > | Units/RigUnitContext.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetUserData | TArray< const UAssetUserData * > | The list of available asset user data object | Units/RigUnitContext.h | |
| ControlRig | UControlRig * | Units/RigUnitContext.h | ||
| Hierarchy | URigHierarchy * | Units/RigUnitContext.h | ||
| OnAddShapeLibraryDelegate | FOnAddShapeLibrary | Units/RigUnitContext.h | ||
| OnShapeExistsDelegate | FOnShapeExists | Units/RigUnitContext.h | ||
| UnitContext | FRigUnitContext | Units/RigUnitContext.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Records | FInstructionRecordContainer * | Units/RigUnitContext.h | ||
| RecordsStorage | FInstructionRecordContainer | Units/RigUnitContext.h | ||
| RigModuleInstance | const FRigModuleInstance * | Units/RigUnitContext.h | ||
| RigModulePrefix | FString | Units/RigUnitContext.h | ||
| RigModulePrefixHash | uint32 | Units/RigUnitContext.h | ||
| RigParentModulePrefix | FString | Units/RigUnitContext.h | ||
| RigRootModulePrefix | FString | Units/RigUnitContext.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName AdaptMetadataName
(
ERigMetaDataNameSpace InNameSpaceType, |
Adapts a metadata name according to rig module namespace. | Units/RigUnitContext.h | |
void AddReadInstructionRecord
(
const FInstructionRecord& InRecord |
Units/RigUnitContext.h | ||
void AddWrittenInstructionRecord
(
const FInstructionRecord& InRecord |
Units/RigUnitContext.h | ||
const UNameSpacedUserData * FindUserData
(
const FString& InNameSpace |
Finds a name spaced user data object | Units/RigUnitContext.h | |
const FString & GetElementModulePrefix
(
ERigMetaDataNameSpace InNameSpaceType |
Returns the namespace given a namespace type | Units/RigUnitContext.h | |
const FInstructionRecordContainer & GetInstructionRecords() |
Units/RigUnitContext.h | ||
uint32 GetInstructionRecordsHash() |
Units/RigUnitContext.h | ||
const FRigModuleInstance * GetRigModuleInstance () |
Returns the module this unit is running inside of (or nullptr) | Units/RigUnitContext.h | |
const FRigModuleInstance * GetRigModuleInstance
(
ERigMetaDataNameSpace InNameSpaceType |
Returns the module this unit is running inside of (or nullptr) | Units/RigUnitContext.h | |
const FString & GetRigModulePrefix() |
Returns the rig module prefix | Units/RigUnitContext.h | |
const FString & GetRigParentModulePrefix() |
Returns the prefix of the root rig module | Units/RigUnitContext.h | |
const FString & GetRigRootModulePrefix() |
Returns the prefix of the parent rig module | Units/RigUnitContext.h | |
bool IsRigModule() |
Returns true if this context is used on a module currently | Units/RigUnitContext.h | |
bool IsRunningAConstructionEvent() |
Returns true if the event currently running is considered a construction or post-construction event | Units/RigUnitContext.h | |
void ResetInstructionRecords() |
Units/RigUnitContext.h |
Overridden from FRigVMExecuteContext
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Copy
(
const FRigVMExecuteContext* InOtherContext |
Units/RigUnitContext.h | ||
virtual void Report
(
const FRigVMLogSettings& InLogSettings, |
Units/RigUnitContext.h |