Navigation
API > API/Plugins > API/Plugins/ControlRig
SetControlTranslationOffset is used to perform a change in the hierarchy by setting a single control's translation offset. This is typically only used during the Construction Event.
| Name | FRigUnit_SetControlTranslationOffset |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Hierarchy/RigUnit_SetControlOffset.h |
| Include Path | #include "Units/Hierarchy/RigUnit_SetControlOffset.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Set Control Translation Offset", Category="Controls", TemplateName="SetControlOffset", DocumentationPolicy="Strict", Keywords="SetControlOffset,Initial,InitialTransform,SetInitialTransform,SetInitialControlTransform,SetControlTranslationOffset,SetInitialTranslation,SetInitialLocation", NodeColor="0, 0.364706, 1.0", Varying))
struct FRigUnit_SetControlTranslationOffset : public FRigUnitMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_SetControlTranslationOffset
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SetControlTranslationOffset() |
Units/Hierarchy/RigUnit_SetControlOffset.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedControlIndex | FCachedRigElement | User to internally cache the index of the bone | Units/Hierarchy/RigUnit_SetControlOffset.h | |
| Control | FName | The name of the Control to set the transform for. | Units/Hierarchy/RigUnit_SetControlOffset.h |
|
| Offset | FVector | The input translation offset to set on the control | Units/Hierarchy/RigUnit_SetControlOffset.h |
|
| Space | ERigVMTransformSpace | Defines if the control's transform should be set in local or global space. | Units/Hierarchy/RigUnit_SetControlOffset.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Hierarchy/RigUnit_SetControlOffset.h | ||
virtual FString GetUnitLabel() |
Units/Hierarchy/RigUnit_SetControlOffset.h |