Navigation
API > API/Plugins > API/Plugins/ControlRig
SetBoneTransform is used to perform a change in the hierarchy by setting a single bone's transform.
| Name | FRigUnit_SetBoneTransform |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Hierarchy/RigUnit_SetBoneTransform.h |
| Include Path | #include "Units/Hierarchy/RigUnit_SetBoneTransform.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Set Transform", Category="Hierarchy", DocumentationPolicy="Strict", Keywords="SetBoneTransform", Deprecated="4.25"))
struct FRigUnit_SetBoneTransform : public FRigUnitMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_SetBoneTransform
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SetBoneTransform() |
Units/Hierarchy/RigUnit_SetBoneTransform.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Bone | FName | The name of the Bone to set the transform for. | Units/Hierarchy/RigUnit_SetBoneTransform.h |
|
| bPropagateToChildren | bool | If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. | Units/Hierarchy/RigUnit_SetBoneTransform.h |
|
| CachedBone | FCachedRigElement | Used to cache the internally used bone index. | Units/Hierarchy/RigUnit_SetBoneTransform.h |
|
| Result | FTransform | The transform value result (after weighting) | Units/Hierarchy/RigUnit_SetBoneTransform.h |
|
| Space | ERigVMTransformSpace | Defines if the bone's transform should be set in local or global space. | Units/Hierarchy/RigUnit_SetBoneTransform.h |
|
| Transform | FTransform | The transform value to set for the given Bone. | Units/Hierarchy/RigUnit_SetBoneTransform.h |
|
| Weight | float | The weight of the change - how much the change should be applied | Units/Hierarchy/RigUnit_SetBoneTransform.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Hierarchy/RigUnit_SetBoneTransform.h | ||
virtual FRigVMStructUpgradeInfo GetUpgradeInfo() |
Units/Hierarchy/RigUnit_SetBoneTransform.h |