1. Epic GamesDeveloper
  3. FRigUnit_Control

FRigUnit_Control

A control unit used to drive a transform from an external source

API > API/Plugins > API/Plugins/ControlRig

A control unit used to drive a transform from an external source

   
Name FRigUnit_Control
Type struct
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Control/RigUnit_Control.h
Include Path #include "Units/Control/RigUnit_Control.h"

Syntax

USTRUCT (  
        Meta=(DisplayName="Control", Category="Controls", ShowVariableNameInTitle, Deprecated="4.24.0"))  
struct FRigUnit_Control : public FRigUnit

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FRigUnit_Control()

   Units/Control/RigUnit_Control.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Base FTransform The base that transform is relative to Units/Control/RigUnit_Control.h
  • Meta=(Input)
bIsInitialized bool   Units/Control/RigUnit_Control.h  
Filter FTransformFilter The filter determines what axes can be manipulated by the in-viewport widgets Units/Control/RigUnit_Control.h
  • Meta=(Input)
InitTransform FTransform The initial transform that The Transform is initialized to. Units/Control/RigUnit_Control.h
  • Meta=(Input)
Result FTransform The resultant transform of this unit (Base * Filter(Transform)) Units/Control/RigUnit_Control.h
  • Meta=(Output)
Transform FEulerTransform The transform of this control Units/Control/RigUnit_Control.h
  • EditAnywhere
  • Category="Control"
  • Interp
  • Meta=(AnimationInput)

Functions

Public

Name Remarks Include Path Unreal Specifiers

FEulerTransform GetFilteredTransform()

 Get the local transform (i.e. without base) with filter applied Units/Control/RigUnit_Control.h  

FMatrix GetResultantMatrix()

 Combine Transform and Base to make the resultant transform (as a matrix) Units/Control/RigUnit_Control.h  

FTransform GetResultantTransform()

 Combine Transform and Base to make the resultant transform Units/Control/RigUnit_Control.h  

void SetResultantMatrix ( const FMatrix& InResultantMatrix
)

 Set the transform using a resultant matrix (already incorporating Base) Units/Control/RigUnit_Control.h  

void SetResultantTransform ( const FTransform& InResultantTransform
)

 Set the transform using a resultant transform (already incorporating Base) Units/Control/RigUnit_Control.h  

Overridden from FRigVMStruct

Name Remarks Include Path Unreal Specifiers

virtual void Execute()

   Units/Control/RigUnit_Control.h  

virtual FRigVMStructUpgradeInfo GetUpgradeInfo()

   Units/Control/RigUnit_Control.h  

Static

Name Remarks Include Path Unreal Specifiers

static FEulerTransform StaticGetFilteredTransform ( const FEulerTransform& InTransform,
const FTransformFilter& InFilter
)

   Units/Control/RigUnit_Control.h  

static FMatrix StaticGetResultantMatrix ( const FEulerTransform& InTransform,
const FTransform& InBase,
const FTransformFilter& InFilter
)

   Units/Control/RigUnit_Control.h  

static FTransform StaticGetResultantTransform ( const FEulerTransform& InTransform,
const FTransform& InBase,
const FTransformFilter& InFilter
)

   Units/Control/RigUnit_Control.h  

static void StaticSetResultantMatrix ( const FMatrix& InResultantMatrix,
const FTransform& InBase,
FEulerTransform& OutTransform
)

   Units/Control/RigUnit_Control.h  

static void StaticSetResultantTransform ( const FTransform& InResultantTransform,
const FTransform& InBase,
FEulerTransform& OutTransform
)

   Units/Control/RigUnit_Control.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page