unreal.RigUnit_OffsetTransformForItem

class unreal.RigUnit_OffsetTransformForItem(execute_context: ControlRigExecuteContext = [], item: RigElementKey = Ellipsis, offset_transform: Transform = Ellipsis, weight: float = 0.0, propagate_to_children: bool = False)

Bases: RigUnitMutable

Offset Transform is used to add an offset to an existing transform in the hierarchy. The offset is post multiplied.

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_OffsetTransform.h

Editor Properties: (see get_editor_property/set_editor_property)

  • execute_context (ControlRigExecuteContext): [Read-Write] * This property is used to chain multiple mutable units together

  • item (RigElementKey): [Read-Write] The item to offset the transform for

  • offset_transform (Transform): [Read-Write] The transform of the item relative to its previous transform

  • propagate_to_children (bool): [Read-Write] If set to true children of affected items in the hierarchy will follow the transform change - otherwise only the parent will move.

  • weight (float): [Read-Write] Defines how much the change will be applied

property item: RigElementKey

[Read-Write] The item to offset the transform for

Type:

(RigElementKey)

property offset_transform: Transform

[Read-Write] The transform of the item relative to its previous transform

Type:

(Transform)

property propagate_to_children: bool

[Read-Write] 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 weight: float

[Read-Write] Defines how much the change will be applied

Type:

(float)