Navigation
API > API/Plugins > API/Plugins/ControlRig
Offset Transform is used to add an offset to an existing transform in the hierarchy. The offset is post multiplied.
| Name | FRigUnit_OffsetTransformForItem |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Hierarchy/RigUnit_OffsetTransform.h |
| Include Path | #include "Units/Hierarchy/RigUnit_OffsetTransform.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Offset Transform", Category="Transforms", DocumentationPolicy="Strict", Keywords="Offset,Relative,AddBoneTransform", NodeColor="0, 0.364706, 1.0", Varying))
struct FRigUnit_OffsetTransformForItem : public FRigUnitMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_OffsetTransformForItem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_OffsetTransformForItem() |
Units/Hierarchy/RigUnit_OffsetTransform.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| 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_OffsetTransform.h |
|
| CachedIndex | FCachedRigElement | Used to cache the item internally. | Units/Hierarchy/RigUnit_OffsetTransform.h | |
| Item | FRigElementKey | The item to offset the transform for | Units/Hierarchy/RigUnit_OffsetTransform.h |
|
| OffsetTransform | FTransform | The transform of the item relative to its previous transform. | Units/Hierarchy/RigUnit_OffsetTransform.h |
|
| Weight | float | Defines how much the change will be applied. | Units/Hierarchy/RigUnit_OffsetTransform.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_OffsetTransform.h | |
virtual bool UpdateHierarchyForDirectManipulation
(
const URigVMUnitNode* InNode, |
Sets a control's pose to represent this viewport pose target | Units/Hierarchy/RigUnit_OffsetTransform.h |
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Hierarchy/RigUnit_OffsetTransform.h |