Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units > API/Plugins/ControlRig/Units/Hierarchy
Inheritance Hierarchy
- FRigVMStruct
- FRigUnit
- FRigUnitMutable
- FRigUnit_SetTransform
References
| Module | ControlRig |
| Header | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Hierarchy/RigUnit_SetTransform.h |
| Include | #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
Remarks
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).
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bInitial | Defines if the transform should be set as current (false) or initial (true). | |
| bool | bPropagateToChildren | If set to true children of affected items in the hierarchy will follow the transform change - otherwise only the parent will move. | |
| FCachedRigElement | CachedIndex | Used to cache the internally used index. | |
| FRigElementKey | Item | The item to set the transform for | |
| ERigVMTransformSpace | Space | Defines if the transform should be set in local or global space | |
| FTransform | Value | The new transform of the given item. | |
| float | Weight | Defines how much the change will be applied. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Overridden from FRigUnit
| Type | Name | Description | |
|---|---|---|---|
| bool | UpdateDirectManipulationFromHierarchy
(
const URigVMUnitNode* InNode, |
Sets the values on this node based on a viewport pose | |
| bool | UpdateHierarchyForDirectManipulation
(
const URigVMUnitNode* InNode, |
Sets a control's pose to represent this viewport pose target |
Overridden from FRigVMStruct
| Type | Name | Description | |
|---|---|---|---|
| void | Execute () |
Execute logic for this struct | |
| FString | GetUnitLabel () |