FRigUnit

Base class for all rig units

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ControlRig

Header

/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/RigUnit.h

Include

#include "Units/RigUnit.h"

Syntax

USTRUCT(BlueprintType, Meta=(Abstract, NodeColor="0.1 0.1 0.1"))
struct FRigUnit : public FRigVMStruct

Remarks

Base class for all rig units

Constructors

Name Description

Public function

FRigUnit()

Destructors

Name Description

Public function Virtual

~FRigUnit()

Virtual destructor

Functions

Name Description

Public function Virtual Const

FTransform

 

DetermineOffsetTransformForPin

(
    const FString& InPinPath,
    void* InUserContext
)

Public function Virtual Const

FRigElementK...

 

DetermineSpaceForPin

(
    const FString& InPinPath,
    void* InUserContext
)

Public function Virtual

void

 

Execute

(
    const FRigUnitContext& Context
)

Execute logic for this rig unit

Public function Static

FName

 

GetMethodName()

The name of the method used within each rig unit

Public function Virtual Const

FString

 

GetUnitLabel()

Returns the label of this unit