Navigation
API > API/Plugins > API/Plugins/ControlRig
SetRelativeTranslation is used to set a single translation from a hierarchy in the space of another item
| Name | FRigUnit_SetRelativeTranslationForItem |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Hierarchy/RigUnit_SetRelativeTransform.h |
| Include Path | #include "Units/Hierarchy/RigUnit_SetRelativeTransform.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Set Relative Translation", Category="Transforms", TemplateName="Set Relative Transform", DocumentationPolicy="Strict", Keywords="Offset,Local", NodeColor="0, 0.364706, 1.0", Varying))
struct FRigUnit_SetRelativeTranslationForItem : public FRigUnitMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_SetRelativeTranslationForItem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SetRelativeTranslationForItem() |
Units/Hierarchy/RigUnit_SetRelativeTransform.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bParentInitial | bool | Defines if the parent's transform should be determined as current (false) or initial (true). | Units/Hierarchy/RigUnit_SetRelativeTransform.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_SetRelativeTransform.h |
|
| CachedChild | FCachedRigElement | Used to cache the child internally. | Units/Hierarchy/RigUnit_SetRelativeTransform.h | |
| CachedParent | FCachedRigElement | Used to cache the parent internally. | Units/Hierarchy/RigUnit_SetRelativeTransform.h | |
| Child | FRigElementKey | The child item to set the transform for | Units/Hierarchy/RigUnit_SetRelativeTransform.h |
|
| Parent | FRigElementKey | The parent item to use. The child transform will be set in the space of the parent. | Units/Hierarchy/RigUnit_SetRelativeTransform.h |
|
| Value | FVector | The transform of the child item relative to the provided parent. | Units/Hierarchy/RigUnit_SetRelativeTransform.h |
|
| Weight | float | Defines how much the change will be applied. | Units/Hierarchy/RigUnit_SetRelativeTransform.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_SetRelativeTransform.h | |
virtual bool UpdateHierarchyForDirectManipulation
(
const URigVMUnitNode* InNode, |
Sets a control's pose to represent this viewport pose target | Units/Hierarchy/RigUnit_SetRelativeTransform.h |
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Hierarchy/RigUnit_SetRelativeTransform.h |