unreal.RigUnit_AimItem

class unreal.RigUnit_AimItem(execute_context: ControlRigExecuteContext = [], item: RigElementKey = Ellipsis, primary: RigUnit_AimItem_Target = Ellipsis, secondary: RigUnit_AimItem_Target = Ellipsis, weight: float = 0.0, debug_settings: RigUnit_AimBone_DebugSettings = Ellipsis)

Bases: RigUnit_HighlevelBaseMutable

Aligns the rotation of a primary and secondary axis of a bone to a global target. Note: This node operates in global space!

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_AimBone.h

Editor Properties: (see get_editor_property/set_editor_property)

  • debug_settings (RigUnit_AimBone_DebugSettings): [Read-Write] The debug setting for the node

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

  • item (RigElementKey): [Read-Write] The name of the item to align

  • primary (RigUnit_AimItem_Target): [Read-Write] The primary target for the aim

  • secondary (RigUnit_AimItem_Target): [Read-Write] The secondary target for the aim - also referred to as PoleVector / UpVector

  • weight (float): [Read-Write] The weight of the change - how much the change should be applied

property debug_settings: RigUnit_AimBone_DebugSettings

[Read-Write] The debug setting for the node

Type:

(RigUnit_AimBone_DebugSettings)

property item: RigElementKey

[Read-Write] The name of the item to align

Type:

(RigElementKey)

property primary: RigUnit_AimItem_Target

[Read-Write] The primary target for the aim

Type:

(RigUnit_AimItem_Target)

property secondary: RigUnit_AimItem_Target

[Read-Write] The secondary target for the aim - also referred to as PoleVector / UpVector

Type:

(RigUnit_AimItem_Target)

property weight: float

[Read-Write] The weight of the change - how much the change should be applied

Type:

(float)