1. Epic GamesDeveloper
  3. FControlRigHierarchyMappings

FControlRigHierarchyMappings

API > API/Plugins > API/Plugins/ControlRig

   
Name FControlRigHierarchyMappings
Type struct
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Tools/ControlRigHierarchyMappings.h
Include Path #include "Tools/ControlRigHierarchyMappings.h"

Syntax

struct FControlRigHierarchyMappings

Constructors

Name Remarks Include Path Unreal Specifiers

FControlRigHierarchyMappings()

   Tools/ControlRigHierarchyMappings.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnablePoseAdapter bool   Tools/ControlRigHierarchyMappings.h  
ControlRigBoneInputMappingByIndex TArray< TPair< uint16, uint16 > > Complete mapping from skeleton to control rig bone index Tools/ControlRigHierarchyMappings.h  
ControlRigBoneInputMappingByName TMap< FName, uint16 > Rig Hierarchy bone name to required array index mapping Tools/ControlRigHierarchyMappings.h  
ControlRigBoneOutputMappingByIndex TArray< TPair< uint16, uint16 > >   Tools/ControlRigHierarchyMappings.h  
ControlRigBoneOutputMappingByName TMap< FName, uint16 >   Tools/ControlRigHierarchyMappings.h  
ControlRigCurveMappingByIndex TArray< TPair< uint16, FName > > Complete mapping from skeleton to curve name Tools/ControlRigHierarchyMappings.h  
ControlRigCurveMappingByName TMap< FName, FName > Rig Curve name to Curve mapping Tools/ControlRigHierarchyMappings.h  
HierarchyCurveCopied TArray< bool >   Tools/ControlRigHierarchyMappings.h  
PoseAdapter TSharedPtr< FControlRigPoseAdapter >   Tools/ControlRigHierarchyMappings.h  
RefPoseSetterHash TOptional< int32 > A hash to encode the pointer to anim instance. Tools/ControlRigHierarchyMappings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanExecute()

   Tools/ControlRigHierarchyMappings.h  

bool CheckPoseAdapter()

   Tools/ControlRigHierarchyMappings.h  

const TArray< TPair< uint16, uint16 > > & GetControlRigBoneInputMappingByIndex()

   Tools/ControlRigHierarchyMappings.h  

const TMap< FName, uint16 > & GetControlRigBoneInputMappingByName()

   Tools/ControlRigHierarchyMappings.h  

TArray< TPair< uint16, uint16 > > & GetControlRigBoneOutputMappingByIndex()

   Tools/ControlRigHierarchyMappings.h  

TMap< FName, uint16 > & GetControlRigBoneOutputMappingByName()

   Tools/ControlRigHierarchyMappings.h  

void InitializeInstance()

   Tools/ControlRigHierarchyMappings.h  

bool IsPoseAdapterEnabled()

   Tools/ControlRigHierarchyMappings.h  

bool IsUpdateToDate ( const URigHierarchy* InHierarchy
) const

   Tools/ControlRigHierarchyMappings.h  

void LinkToHierarchy ( URigHierarchy* InHierarchy
)

   Tools/ControlRigHierarchyMappings.h  

void PerformUpdateToDate ( UControlRig* ControlRig,
URigHierarchy* InHierarchy,
const FBoneContainer& InRequiredBones,
const TWeakObjectPtr< UNodeMappingContainer >& InNodeMappingContainer,
bool bInTransferPoseInGlobalSpace,
bool bInResetInputPoseToInitial
)

   Tools/ControlRigHierarchyMappings.h  

void ResetRefPoseSetterHash()

   Tools/ControlRigHierarchyMappings.h  

void UpdateControlRigRefPoseIfNeeded ( UControlRig* ControlRig,
const UObject* InstanceObject,
const USkeletalMeshComponent* SkeletalMeshComponent,
const FBoneContainer& RequiredBones,
bool bInSetRefPoseFromSkeleton,
bool bIncludePoseInHash
)

   Tools/ControlRigHierarchyMappings.h  

void UpdateInput ( UControlRig* ControlRig,
FPoseContext& InOutput,
const FControlRigIOSettings& InInputSettings,
const FControlRigIOSettings& InOutputSettings,
TWeakObjectPtr< UNodeMappingContainer >& InNodeMappingContainer,
bool bInExecute,
bool bInTransferInputPose,
bool bInResetInputPoseToInitial,
bool bInTransferPoseInGlobalSpace,
bool bInTransferInputCurves
)

   Tools/ControlRigHierarchyMappings.h  

void UpdateInputOutputMappingIfRequired ( UControlRig* InControlRig,
URigHierarchy* InHierarchy,
const FBoneContainer& InRequiredBones,
const TArray< FBoneReference >& InInputBonesToTransfer,
const TArray< FBoneReference >& InOutputBonesToTransfer,
const TWeakObjectPtr< UNodeMappingContainer >& InNodeMappingContainer,
bool bInTransferPoseInGlobalSpace,
bool bResetInputPoseToInitial
)

   Tools/ControlRigHierarchyMappings.h  

void UpdateOutput ( UControlRig* ControlRig,
FPoseContext& InOutput,
const FControlRigIOSettings& InOutputSettings,
TWeakObjectPtr< UNodeMappingContainer >& InNodeMappingContainer,
bool bInExecute,
bool bInTransferPoseInGlobalSpace
)

   Tools/ControlRigHierarchyMappings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page