1. Epic GamesDeveloper
  3. FControlRigExecuteContext

FControlRigExecuteContext

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units

Inheritance Hierarchy

References

   
Module ControlRig
Header /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/RigUnitContext.h
Include #include "Units/RigUnitContext.h"

Syntax

USTRUCT (BlueprintType )  
struct FControlRigExecuteContext : public FRigVMExecuteContext

Variables

  Type Name Description
Public variable TArray< const UAssetUserData * > AssetUserData The list of available asset user data object
Public variable URigHierarchy * Hierarchy  
Public variable FOnAddShapeLibrary OnAddShapeLibraryDelegate  
Public variable FOnShapeExists OnShapeExistsDelegate  
Public variable FRigUnitContext UnitContext  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const FName

AdaptMetadataName ( ERigMetaDataNameSpace InNameSpaceType,
const FName& InMetadataName
)

 Adapts a metadata name according to rig module namespace.
Public function Const FName

AddRigModuleNameSpace ( const FName& InName
)

 Add the namespace from a given name
Public function Const FString

AddRigModuleNameSpace ( const FString& InName
)

  
Public function Const const UNameSpacedUserData *

FindUserData ( const FString& InNameSpace
)

 Finds a name spaced user data object
Public function Const FString Returns the namespace given a namespace type
Public function Const const FRigModuleInstance * Returns the module this unit is running inside of (or nullptr)
Public function Const const FRigModuleInstance * Returns the module this unit is running inside of (or nullptr)
Public function Const FString Returns the namespace of the currently running rig module
Public function Const bool Returns true if this context is used on a module currently
Public function Const FName

RemoveRigModuleNameSpace ( const FName& InName
)

 Remove the namespace from a given name
Public function Const FString

RemoveRigModuleNameSpace ( const FString& InName
)

  

Overridden from FRigVMExecuteContext

  Type Name Description
Public function Virtual void

Copy ( const FRigVMExecuteContext* InOtherContext
)

  
Public function Virtual Const void

Report ( const FRigVMLogSettings& InLogSettings,
const FName& InFunctionName,
int32 InInstructionIndex,
const FString& InMessage
)

  

Typedefs

Name Description
FOnAddShapeLibrary  
FOnShapeExists  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page