`unreal.RigUnit_SetBoneTransform`¶

class unreal.RigUnit_SetBoneTransform(execute_context: ControlRigExecuteContext = [], bone: Name = 'None', transform: Transform = Ellipsis, result: Transform = Ellipsis, space: BoneGetterSetterMode = Ellipsis, weight: float = 0.0, propagate_to_children: bool = False)¶

Bases: RigUnitMutable

SetBoneTransform is used to perform a change in the hierarchy by setting a single bone’s transform.

C++ Source:

Plugin: ControlRig
Module: ControlRig
File: RigUnit_SetBoneTransform.h

Editor Properties: (see get_editor_property/set_editor_property)

bone (Name): [Read-Write] Bone: The name of the Bone to set the transform for.
execute_context (ControlRigExecuteContext): [Read-Write] Execute Context: * This property is used to chain multiple mutable units together
propagate_to_children (bool): [Read-Only] Propagate to Children: If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. Note: This is computationally more expensive than turning it off.
result (Transform): [Read-Write] Result: The transform value result (after weighting)
space (BoneGetterSetterMode): [Read-Write] Space: Defines if the bone’s transform should be set in local or global space.
transform (Transform): [Read-Write] Transform: The transform value to set for the given Bone.
weight (float): [Read-Write] Weight: The weight of the change - how much the change should be applied

property bone: Name¶

[Read-Write] Bone: The name of the Bone to set the transform for.

Type:: (Name)

property propagate_to_children: bool¶

[Read-Only] Propagate to Children: If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. Note: This is computationally more expensive than turning it off.