1. Epic GamesDeveloper
  3. UModularRig

UModularRig

Runs logic for mapping input data to transforms (the "Rig")

API > API/Plugins > API/Plugins/ControlRig

Runs logic for mapping input data to transforms (the "Rig")

   
Name UModularRig
Type class
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/ModularRig.h
Include Path #include "ModularRig.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, Abstract, EditInlineNew)  
class UModularRig : public UControlRig

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UModularRig ( const FObjectInitializer& ObjectInitializer
)

   ModularRig.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ExecutionQueue TArray< FRigModuleExecutionElement >   ModularRig.h  
ExecutionQueueFront int32   ModularRig.h  
ModularRigModel FModularRigModel   ModularRig.h  
ModularRigSettings FModularRigSettings   ModularRig.h  
Modules TArray< FRigModuleInstance >   ModularRig.h  
RootModules TArray< FRigModuleInstance * >   ModularRig.h  
SupportedEvents TArray< FName >   ModularRig.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
LastExecutedElements TArray< FRigModuleExecutionElement >   ModularRig.h  
LastExecutionQueue FRigModuleExecutionQueue   ModularRig.h  
LastExecutionQueueLock FRWLock   ModularRig.h  
PreviousModuleRigs TMap< FName, UControlRig * >   ModularRig.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ExecuteConnectorEvent ( const FRigElementKey& InConnector,
const FRigModuleInstance* InModuleInstance,
const FRigElementKeyRedirector* InRedirector,
TArray< FRigElementResolveResult >& InOutCandidates
)

   ModularRig.h  

TArray< FName > ExecuteEventOnAllModules ( FName InEvent
)

   ModularRig.h
  • BlueprintCallable
  • Category=ModularRig

bool ExecuteEventOnModule ( const FName& InEvent,
FRigModuleInstance* InModule
)

   ModularRig.h
  • BlueprintCallable
  • Category=ModularRig
  • Meta=(ScriptName="ExecuteEventOnModuleByName", DisplayName="Execute Event On Module By Name")

bool ExecuteEventOnModuleByNameForBP ( FName InEvent,
FName InModuleName
)

   ModularRig.h
  • BlueprintCallable
  • Category=ModularRig
  • Meta=(ScriptName="ExecuteEventOnModuleByName", DisplayName="Execute Event On Module By Name")

bool ExecuteEventOnModuleForBP ( FName InEvent,
FString InModulePath
)

   ModularRig.h
  • BlueprintCallable
  • Category=ModularRig
  • Meta=(ScriptName="ExecuteEventOnModule", DisplayName="Execute Event On Module", DeprecatedFunction, DeprecationMessage="Function has been deprecated, please rely on ExecuteEventOnModuleByName instead.")

void ExecuteQueue()

   ModularRig.h  

const FRigModuleInstance * FindModule ( const FRigBaseElement* InElement
) const

   ModularRig.h  

const FRigModuleInstance * FindModule ( const FRigElementKey& InElementKey
) const

   ModularRig.h  

FRigModuleInstance * FindModule ( const FName& InModuleName
)

   ModularRig.h  

FRigModuleInstance * FindModule ( const UControlRig* InModuleInstance
)

   ModularRig.h  
  ModularRig.h  

FRigModuleInstance * FindModule ( const FRigElementKey& InElementKey
)

   ModularRig.h  

const FRigModuleInstance * FindModule ( const UControlRig* InModuleInstance
) const

   ModularRig.h  

const FRigModuleInstance * FindModule ( const FName& InModuleName
) const

   ModularRig.h  

const FRigModuleInstance * FindModule_Deprecated ( const FString& InModulePath
) const

   ModularRig.h  
  ModularRig.h  

void ForEachModule ( TFunctionRef< bool(FRigModuleInstance*)> PerModuleFunction,
bool bDepthFirst
)

   ModularRig.h  

void ForEachModule ( TFunctionRef< bool(const FRigModuleInstance*)> PerModuleFunction,
bool bDepthFirst
) const

   ModularRig.h  

TArray< FName > GetEventsForAllModules()

   ModularRig.h
  • BlueprintPure
  • Category=ModularRig

TArray< FName > GetEventsForModule ( FString InModulePath
) const

   ModularRig.h
  • BlueprintPure
  • Category=ModularRig
  • Meta=(DeprecatedFunction, DeprecationMessage="Function has been deprecated, please rely on GetEventsForModuleByName instead.")

TArray< FName > GetEventsForModuleByName ( FName InModuleName
) const

   ModularRig.h
  • BlueprintPure
  • Category=ModularRig

FModuleInstanceHandle GetHandle ( const FName& InModuleName
) const

 Returns a handle to an existing module ModularRig.h  

FRigModuleExecutionQueue GetLastExecutionQueue()

   ModularRig.h  

const FModularRigModel & GetModularRigModel()

   ModularRig.h  

const FModularRigSettings & GetModularRigSettings()

 Returns the settings of the modular rig. ModularRig.h  

TArray< FName > GetModuleNames()

   ModularRig.h
  • BlueprintPure
  • Category=ModularRig

TArray< FString > GetModulePaths()

   ModularRig.h
  • BlueprintPure
  • Category=ModularRig
  • Meta=(DeprecatedFunction, DeprecationMessage="Function has been deprecated, please rely on GetModuleNames instead.")

UControlRig * GetModuleRig ( FString InModulePath
)

   ModularRig.h
  • BlueprintCallable
  • Category=ModularRig
  • Meta=(DeprecatedFunction, DeprecationMessage="Function has been deprecated, please rely on GetModuleRigByName instead.")

const UControlRig * GetModuleRig_Deprecated ( FString InModulePath
) const

   ModularRig.h
  • BlueprintCallable
  • Category=ModularRig
  • Meta=(DeprecatedFunction, DeprecationMessage="Function has been deprecated, please rely on GetModuleRigByName instead.")

const UControlRig * GetModuleRigByName ( FName InModuleName
) const

   ModularRig.h
  • BlueprintCallable
  • Category=ModularRig

UControlRig * GetModuleRigByName ( FName InModuleName
)

   ModularRig.h
  • BlueprintCallable
  • Category=ModularRig

FName GetParentModuleName ( const FName& InModuleName
) const

   ModularRig.h
  • BlueprintPure
  • Category=ModularRig
  • Meta=(ScriptName="GetParentModuleName", DisplayName="Get Parent Module Name")

FName GetParentModuleNameForBP ( FName InModuleName
) const

   ModularRig.h
  • BlueprintPure
  • Category=ModularRig
  • Meta=(ScriptName="GetParentModuleName", DisplayName="Get Parent Module Name")

FString GetParentPathForBP ( FString InModulePath
) const

   ModularRig.h
  • BlueprintPure
  • Category=ModularRig
  • Meta=(ScriptName="GetParentPath", DisplayName="Get Parent Path", DeprecatedFunction, DeprecationMessage="Function has been deprecated, please rely on GetParentModuleName instead.")

void OnObjectsReplaced ( const TMap< UObject*, UObject* >& OldToNewInstanceMap
)

   ModularRig.h  

void ResetExecutionQueue()

   ModularRig.h  

void ResetModules ( bool bDestroyModuleRigs
)

   ModularRig.h  

void UpdateCachedChildren()

   ModularRig.h  

void UpdateModuleHierarchyFromCDO()

   ModularRig.h  

void UpdateSupportedEvents()

   ModularRig.h  

Overridden from UControlRig

Name Remarks Include Path Unreal Specifiers

virtual void GetControlsInOrder ( TArray< FRigControlElement* >& SortedControls
) const

   ModularRig.h  
  ModularRig.h  
Returns the redirector from key to key for this rig. ModularRig.h  

virtual bool InitializeVMs ( const FName& InEventName
)

   ModularRig.h  

virtual void InitializeVMs ( bool bRequestInit
)

   ModularRig.h  

virtual void InitializeVMsFromCDO()

   ModularRig.h  

virtual void RequestInitVMs()

   ModularRig.h  

Overridden from URigVMHost

Name Remarks Include Path Unreal Specifiers

virtual void Evaluate_AnyThread()

 Evaluates the ControlRig ModularRig.h  

virtual bool Execute_Internal ( const FName& InEventName
)

   ModularRig.h  

virtual const TArray< FName > & GetSupportedEvents()

   ModularRig.h  

virtual void InitializeFromCDO()

   ModularRig.h  

virtual void PostInitInstance ( URigVMHost* InCDO
)

 BEGIN ControlRig. ModularRig.h  

virtual bool SupportsEvent ( const FName& InEventName
) const

   ModularRig.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

 BEGIN UObject. ModularRig.h  

virtual void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

   ModularRig.h  

virtual void PostInitProperties()

   ModularRig.h  

virtual void PostLoad()

   ModularRig.h  

virtual void Serialize ( FArchive& Ar
)

   ModularRig.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DiscardModuleRig ( UControlRig* InControlRig
)

 Destroys / discards a module instance rig ModularRig.h  

static bool TraverseModules ( FRigModuleInstance* InModuleInstance,
TFunctionRef< bool(FRigModuleInstance*)> PerModule
)

   ModularRig.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page