Navigation
API > API/Plugins > API/Plugins/ControlRig
Rig that allows override editing per joint
| Name | UFKControlRig |
| Type | class |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/FKControlRig.h |
| Include Path | #include "Rigs/FKControlRig.h" |
Syntax
UCLASS (MinimalAPI, NotBlueprintable, Meta=(DisplayName="FK Control Rig"))
class UFKControlRig : public UControlRig
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → URigVMHost → UControlRig → UFKControlRig
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UFKControlRig
(
const FObjectInitializer& ObjectInitializer |
Rigs/FKControlRig.h |
Structs
| Name | Remarks |
|---|---|
| FRigElementInitializationOptions |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ApplyMode | EControlRigFKRigExecuteMode | Rigs/FKControlRig.h | ||
| CachedToggleApplyMode | EControlRigFKRigExecuteMode | Rigs/FKControlRig.h | ||
| InitializationOptions | FRigElementInitializationOptions | Rigs/FKControlRig.h | ||
| IsControlActive | TArray< bool > | Rigs/FKControlRig.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanToggleApplyMode() |
Rigs/FKControlRig.h | ||
EControlRigFKRigExecuteMode GetApplyMode() |
Rigs/FKControlRig.h | ||
bool GetControlActive
(
int32 Index |
Rigs/FKControlRig.h | ||
| Rigs/FKControlRig.h | |||
void RefreshActiveControls() |
Ensures that controls mask is updated according to contained ControlRig (control) elements. | Rigs/FKControlRig.h | |
void SetApplyMode
(
EControlRigFKRigExecuteMode InMode |
Rigs/FKControlRig.h | ||
void SetControlActive
(
const TArray< FFKBoneCheckInfo >& InBoneChecks |
Rigs/FKControlRig.h | ||
void SetControlActive
(
int32 Index, |
Rigs/FKControlRig.h | ||
void SetInitializationOptions
(
const FRigElementInitializationOptions& Options |
Rigs/FKControlRig.h | ||
void ToggleApplyMode() |
Rigs/FKControlRig.h |
Overridden from UControlRig
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool InitializeVMs
(
const FName& InEventName |
Rigs/FKControlRig.h | ||
virtual void InitializeVMs
(
bool bRequestInit |
Rigs/FKControlRig.h | ||
virtual void InitializeVMsFromCDO() |
Rigs/FKControlRig.h | ||
virtual bool IsAdditive() |
Rigs/FKControlRig.h | ||
virtual void RequestInitVMs() |
Rigs/FKControlRig.h | ||
virtual void SetBoneInitialTransformsFromSkeletalMeshComponent
(
USkeletalMeshComponent* InSkelMeshComp, |
Setup the initial transform / ref pose of the bones based upon skeletal mesh component (ref skeleton) This uses the RefSkeleton pose instead of the current refpose (or vice versae is bUseAnimInstance == true) | Rigs/FKControlRig.h |
Overridden from URigVMHost
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Execute_Internal
(
const FName& InEventName |
Rigs/FKControlRig.h | ||
virtual void Initialize
(
bool bInitRigUnits |
BEGIN ControlRig. | Rigs/FKControlRig.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetControlName
(
const FName& InName, |
Utility function to generate a valid control element name | Rigs/FKControlRig.h | |
static FName GetControlTargetName
(
const FName& InName, |
Utility function to generate a target element name for control | Rigs/FKControlRig.h |