unreal.RigUnit_AimConstraintLocalSpaceOffset

class unreal.RigUnit_AimConstraintLocalSpaceOffset(execute_context: ControlRigExecuteContext = [], child: RigElementKey = Ellipsis, maintain_offset: bool = False, filter: FilterOptionPerAxis = Ellipsis, aim_axis: Vector = Ellipsis, up_axis: Vector = Ellipsis, world_up: RigUnit_AimConstraint_WorldUp = Ellipsis, parents: None = [], advanced_settings: RigUnit_AimConstraint_AdvancedSettings = Ellipsis, weight: float = 0.0)

Bases: RigUnit_HighlevelBaseMutable

Orients an item such that its aim axis points towards 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)

  • advanced_settings (RigUnit_AimConstraint_AdvancedSettings): [Read-Write]

  • aim_axis (Vector): [Read-Write] Child is rotated so that its AimAxis points to the parents

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

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

  • filter (FilterOptionPerAxis): [Read-Write] Filters the final rotation by axes based on the euler rotation order defined in the node’s advanced settings If flipping is observed, try adjusting the rotation order

  • maintain_offset (bool): [Read-Write] Maintains the offset between child and weighted average of parents based on initial transforms

  • parents (Array[ConstraintParent]): [Read-Write]

  • up_axis (Vector): [Read-Write] Child is rotated around the AimAxis so that its UpAxis points to/Aligns with the WorldUp target

  • weight (float): [Read-Write]

  • world_up (RigUnit_AimConstraint_WorldUp): [Read-Write] Defines how Child should rotate around the AimAxis. This is the aim target for the UpAxis

property advanced_settings: RigUnit_AimConstraint_AdvancedSettings

[Read-Write]

Type:

(RigUnit_AimConstraint_AdvancedSettings)

property aim_axis: Vector

[Read-Write] Child is rotated so that its AimAxis points to the parents

Type:

(Vector)

property child: RigElementKey

[Read-Write] The name of the item to apply aim

Type:

(RigElementKey)

property filter: FilterOptionPerAxis

[Read-Write] Filters the final rotation by axes based on the euler rotation order defined in the node’s advanced settings If flipping is observed, try adjusting the rotation order

Type:

(FilterOptionPerAxis)

property maintain_offset: bool

[Read-Write] Maintains the offset between child and weighted average of parents based on initial transforms

Type:

(bool)

property parents: None

[Read-Write]

Type:

(Array[ConstraintParent])

property up_axis: Vector

[Read-Write] Child is rotated around the AimAxis so that its UpAxis points to/Aligns with the WorldUp target

Type:

(Vector)

property weight: float

[Read-Write]

Type:

(float)

property world_up: RigUnit_AimConstraint_WorldUp

[Read-Write] Defines how Child should rotate around the AimAxis. This is the aim target for the UpAxis

Type:

(RigUnit_AimConstraint_WorldUp)