Navigation
API > API/Plugins > API/Plugins/ControlRig
SetTransform is used to set a single transform on hierarchy.
Note: For Controls when setting the initial transform this node actually sets the Control's offset transform and resets the local values to (0, 0, 0).
| Name | FRigUnit_SetTransform |
| 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 Transform", Category="Transforms", TemplateName="Set Transform", DocumentationPolicy="Strict", Keywords="SetBoneTransform,SetControlTransform,SetInitialTransform,SetSpaceTransform", NodeColor="0, 0.364706, 1.0", Varying))
struct FRigUnit_SetTransform : public FRigUnitMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_SetTransform
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SetTransform() |
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 transform for | Units/Hierarchy/RigUnit_SetTransform.h |
|
| Space | ERigVMTransformSpace | Defines if the transform should be set in local or global space | Units/Hierarchy/RigUnit_SetTransform.h |
|
| Value | FTransform | The new transform 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 |