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 > API/Plugins/ControlRig/Units > API/Plugins/ControlRig/Units/Control

Inheritance Hierarchy

References

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

Syntax

USTRUCT&40;  
        Meta&61;&40;DisplayName&61;"Control", Category&61;"Controls", ShowVariableNameInTitle, Deprecated&61;"4.24.0"&41;&41;  
struct FRigUnit_Control : public FRigUnit

Remarks

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

Variables

  Type Name Description
Public variable UProperty Meta FTransform Base The base that transform is relative to
Public variable bool bIsInitialized  
Public variable UProperty Meta FTransformFilter Filter The filter determines what axes can be manipulated by the in-viewport widgets
Public variable UProperty Meta FTransform InitTransform The initial transform that The Transform is initialized to.
Public variable UProperty Meta FTransform Result The resultant transform of this unit (Base * Filter(Transform))
Public variable UProperty Category, EditAnywhere, Interp, Meta FEulerTransform Transform The transform of this control

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const FEulerTransform Get the local transform (i.e. without base) with filter applied
Public function Const FMatrix Combine Transform and Base to make the resultant transform (as a matrix)
Public function Const FTransform Combine Transform and Base to make the resultant transform
Public function void

SetResultantMatrix ( const FMatrix& InResultantMatrix
)

 Set the transform using a resultant matrix (already incorporating Base)
Public function void

SetResultantTransform ( const FTransform& InResultantTransform
)

 Set the transform using a resultant transform (already incorporating Base)
Public function Static FEulerTransform

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

 Get the local transform (i.e. without base) with filter applied
Public function Static FMatrix

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

 Combine Transform and Base to make the resultant transform (as a matrix)
Public function Static FTransform

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

 Combine Transform and Base to make the resultant transform
Public function Static void

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

 Set the transform using a resultant matrix (already incorporating Base)
Public function Static void

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

 Set the transform using a resultant transform (already incorporating Base)

Overridden from FRigVMStruct

  Type Name Description
Public function Virtual void

Execute ()

 Execute logic for this struct
Public function Virtual Const FRigVMStructUpgradeInfo  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page