Navigation
API > API/Plugins > API/Plugins/ControlRig
ModifyBonetransforms is used to perform a change in the hierarchy by setting one or more bones' transforms.
| Name | FRigUnit_ModifyBoneTransforms |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |
| Include Path | #include "Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Modify Transforms", Category="Hierarchy", DocumentationPolicy="Strict", Keywords="ModifyBone", Deprecated="4.25"))
struct FRigUnit_ModifyBoneTransforms : public FRigUnit_HighlevelBaseMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_HighlevelBaseMutable → FRigUnit_ModifyBoneTransforms
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_ModifyBoneTransforms() |
Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BoneToModify | TArray< FRigUnit_ModifyBoneTransforms_PerBone > | The bones to modify. | Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |
|
| Mode | EControlRigModifyBoneMode | Defines if the bone's transform should be set in local or global space, additive or override. | Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |
|
| Weight | float | At 1 this sets the transform, between 0 and 1 the transform is blended with previous results. | Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |
|
| WeightMaximum | float | The maximum of the weight - defaults to 1.0 | Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |
|
| WeightMinimum | float | The minimum of the weight - defaults to 0.0 | Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |
|
| WorkData | FRigUnit_ModifyBoneTransforms_WorkData | Used to cache the internally used bone index. | Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h | ||
virtual FRigVMStructUpgradeInfo GetUpgradeInfo() |
Units/Highlevel/Hierarchy/RigUnit_ModifyBoneTransforms.h |