Navigation
API > API/Plugins > API/Plugins/ControlRig
SetTranslation is used to set a single translation on hierarchy.
| Name | FRigUnit_SetTranslation |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Hierarchy/RigUnit_SetTransform.h |
| Include Path | #include "Units/Hierarchy/RigUnit_SetTransform.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Set Translation", Category="Transforms", TemplateName="Set Transform", DocumentationPolicy="Strict", Keywords="SetBoneTranslation,SetControlTranslation,SetInitialTranslation,SetSpaceTranslation,SetBoneLocation,SetControlLocation,SetInitialLocation,SetSpaceLocation,SetBonePosition,SetControlPosition,SetInitialPosition,SetSpacePosition,SetTranslation,SetLocation,SetPosition", NodeColor="0, 0.364706, 1.0", Varying))
struct FRigUnit_SetTranslation : public FRigUnitMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_SetTranslation
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SetTranslation() |
Units/Hierarchy/RigUnit_SetTransform.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInitial | bool | Defines if the transform should be set as current (false) or initial (true). | Units/Hierarchy/RigUnit_SetTransform.h |
|
| bPropagateToChildren | bool | If set to true children of affected items in the hierarchy will follow the transform change - otherwise only the parent will move. | Units/Hierarchy/RigUnit_SetTransform.h |
|
| CachedIndex | FCachedRigElement | Used to cache the internally used index. | Units/Hierarchy/RigUnit_SetTransform.h | |
| Item | FRigElementKey | The item to set the translation for | Units/Hierarchy/RigUnit_SetTransform.h |
|
| Space | ERigVMTransformSpace | Defines if the translation should be set in local or global space | Units/Hierarchy/RigUnit_SetTransform.h |
|
| Value | FVector | The new translation of the given item. | Units/Hierarchy/RigUnit_SetTransform.h |
|
| Weight | float | Defines how much the change will be applied. | Units/Hierarchy/RigUnit_SetTransform.h |
|
Functions
Public
Overridden from FRigUnit
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool UpdateDirectManipulationFromHierarchy
(
const URigVMUnitNode* InNode, |
Sets the values on this node based on a viewport pose | Units/Hierarchy/RigUnit_SetTransform.h | |
virtual bool UpdateHierarchyForDirectManipulation
(
const URigVMUnitNode* InNode, |
Sets a control's pose to represent this viewport pose target | Units/Hierarchy/RigUnit_SetTransform.h |
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Hierarchy/RigUnit_SetTransform.h | ||
virtual FString GetUnitLabel() |
Units/Hierarchy/RigUnit_SetTransform.h |