unreal.RetargetPoleVectorSettings

class unreal.RetargetPoleVectorSettings(target_chain_name: Name = 'None', enabled: bool = False, align_alpha: float = 0.0, static_angular_offset: float = 0.0, maintain_offset: bool = False)

Bases: StructBase

Retarget Pole Vector Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: AlignPoleVectorOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • align_alpha (double): [Read-Write] Range 0 to 1. Default 1. Matches the twist angle of this chain (along the Pole direction) to the source chain. At 0, the chain’s pole vector direction will be left alone At 1, the root bone of the chain will be twist-rotated in the pole direction to match the orientation of the source chain.

  • enabled (bool): [Read-Write] Enable pole vector alignment on this chain.

  • maintain_offset (bool): [Read-Write] Default is False. When true, the original angular offset between the source/target pole vectors will be maintained when aligning pole vectors.

  • static_angular_offset (double): [Read-Write] Range +/- 180. Default 0. An angular offset, in degrees, for the pole direction of the chain.

  • target_chain_name (Name): [Read-Write] The name of the target chain to align pole vectors on.

property align_alpha: float

[Read-Write] Range 0 to 1. Default 1. Matches the twist angle of this chain (along the Pole direction) to the source chain. At 0, the chain’s pole vector direction will be left alone At 1, the root bone of the chain will be twist-rotated in the pole direction to match the orientation of the source chain.

Type:

(double)

property enabled: bool

[Read-Write] Enable pole vector alignment on this chain.

Type:

(bool)

property maintain_offset: bool

[Read-Write] Default is False. When true, the original angular offset between the source/target pole vectors will be maintained when aligning pole vectors.

Type:

(bool)

property static_angular_offset: float

[Read-Write] Range +/- 180. Default 0. An angular offset, in degrees, for the pole direction of the chain.

Type:

(double)

property target_chain_name: Name

[Read-Write] The name of the target chain to align pole vectors on.

Type:

(Name)