FRigUnit_Control

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ControlRig

Header

/Engine/Plugins/Experimental/ControlRig/Source/ControlRig/Public/Units/Control/RigUnit_Control.h

Include

#include "Units/Control/RigUnit_Control.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)(
        Meta=(DisplayName="Control", Category="Controls", ShowVariableNameInTitle, Deprecated="4.24.0"))
struct FRigUnit_Control : public FRigUnit

Remarks

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

Variables

Name Description

Public variable UProperty Meta

FTransform

 

Base

The base that transform is relative to

Public variable

FTransformFilte...

 

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

Name Description

Public function

FRigUnit_Control()

Functions

Name Description

Public function Const

FEulerTransf...

 

GetFilteredTransform()

Get the local transform (i.e. without base) with filter applied

Public function Const

FMatrix

 

GetResultantMatrix()

Combine Transform and Base to make the resultant transform (as a matrix)

Public function Const

FTransform

 

GetResultantTransform()

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& InResultantTrans...
)

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

Public function Static

FEulerTransf...

 

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& InResultantTrans...,
    const FTransform& InBase,
    FEulerTransform& OutTransform
)

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

Overridden from FRigUnit

Name Description

Public function Virtual

void

 

Execute

(
    const FRigUnitContext& Context
)

Execute logic for this rig unit
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss