unreal.RigUnit_SetScale
¶
- class unreal.RigUnit_SetScale(execute_context: ControlRigExecuteContext = [], item: RigElementKey = Ellipsis, space: BoneGetterSetterMode = Ellipsis, initial: bool = False, scale: Vector = Ellipsis, weight: float = 0.0, propagate_to_children: bool = False)¶
Bases:
RigUnitMutable
SetScale is used to set a single scale on hierarchy.
C++ Source:
Plugin: ControlRig
Module: ControlRig
File: RigUnit_SetTransform.h
Editor Properties: (see get_editor_property/set_editor_property)
execute_context
(ControlRigExecuteContext): [Read-Write] Execute Context: * This property is used to chain multiple mutable units togetherinitial
(bool): [Read-Write] Initial: Defines if the transform should be set as current (false) or initial (true). Initial transforms for bones and other elements in the hierarchy represent the reference pose’s value.item
(RigElementKey): [Read-Write] Item: The item to set the scale forpropagate_to_children
(bool): [Read-Write] Propagate to Children: If set to true children of affected items in the hierarchy will follow the transform change - otherwise only the parent will move.scale
(Vector): [Read-Write] Scale: The new scale of the given itemspace
(BoneGetterSetterMode): [Read-Write] Space: Defines if the scale should be set in local or global spaceweight
(float): [Read-Write] Weight: Defines how much the change will be applied
- property initial: bool¶
[Read-Write] Initial: Defines if the transform should be set as current (false) or initial (true). Initial transforms for bones and other elements in the hierarchy represent the reference pose’s value.
- Type:
(bool)
- property item: RigElementKey¶
[Read-Write] Item: The item to set the scale for
- Type:
- property propagate_to_children: bool¶
[Read-Write] Propagate to Children: If set to true children of affected items in the hierarchy will follow the transform change - otherwise only the parent will move.
- Type:
(bool)
- property space: BoneGetterSetterMode¶
[Read-Write] Space: Defines if the scale should be set in local or global space
- Type: