unreal.TargetRootSettings

class unreal.TargetRootSettings(rotation_alpha: float = 0.0, translation_alpha: float = 0.0, blend_to_source: float = 0.0, blend_to_source_weights: Vector = Ellipsis, scale_horizontal: float = 0.0, scale_vertical: float = 0.0, translation_offset: Vector = Ellipsis, rotation_offset: Rotator = Ellipsis, affect_ik_horizontal: float = 0.0, affect_ik_vertical: float = 0.0)

Bases: StructBase

Target Root Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: IKRetargetSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • affect_ik_horizontal (float): [Read-Write] Affect IKHorizontal: Range 0 to 1. Default 1. Control whether modifications made to the root will affect the horizontal component of IK positions. At 0 the IK positions are independent of the root modifications. At 1 the IK positions are calculated relative to the modified root location.

  • affect_ik_vertical (float): [Read-Write] Affect IKVertical: Range 0 to 1. Default 0. Control whether modifications made to the root will affect the vertical component of IK positions. At 0 the IK positions are independent of the root modifications. At 1 the IK positions are calculated relative to the modified root location.

  • blend_to_source (float): [Read-Write] Blend to Source: Range 0 to 1. Default 0. Blends the retarget root’s translation to the exact source location. At 0 the root is placed at the retargeted location. At 1 the root is placed at the location of the source’s retarget root bone.

  • blend_to_source_weights (Vector): [Read-Write] Blend to Source Weights: Per-axis weights for the Blend to Source.

  • rotation_alpha (float): [Read-Write] Rotation Alpha: Range 0 to 1. Default 1. Blends the amount of retargeted root rotation to apply. At 0 the root is left at the rotation from the retarget pose. At 1 the root is rotated fully to match the source root rotation.

  • rotation_offset (Rotator): [Read-Write] Rotation Offset: Applies a static local-space rotation offset to the retarget root.

  • scale_horizontal (float): [Read-Write] Scale Horizontal: Default 1. Scales the motion of the root position in the horizontal plane (X,Y).

  • scale_vertical (float): [Read-Write] Scale Vertical: Default 1. Scales the motion of the root position in the vertical direction (Z).

  • translation_alpha (float): [Read-Write] Translation Alpha: Range 0 to 1. Default 1. Blends the amount of retargeted root translation to apply. At 0 the root is left at the position from the retarget pose. At 1 the root will follow the source motion according to the behavior defined in the subsequent settings.

  • translation_offset (Vector): [Read-Write] Translation Offset: Applies a static component-space translation offset to the retarget root.

property affect_ik_horizontal: float

[Read-Write] Affect IKHorizontal: Range 0 to 1. Default 1. Control whether modifications made to the root will affect the horizontal component of IK positions. At 0 the IK positions are independent of the root modifications. At 1 the IK positions are calculated relative to the modified root location.

Type:

(float)

property affect_ik_vertical: float

[Read-Write] Affect IKVertical: Range 0 to 1. Default 0. Control whether modifications made to the root will affect the vertical component of IK positions. At 0 the IK positions are independent of the root modifications. At 1 the IK positions are calculated relative to the modified root location.

Type:

(float)

property blend_to_source: float

[Read-Write] Blend to Source: Range 0 to 1. Default 0. Blends the retarget root’s translation to the exact source location. At 0 the root is placed at the retargeted location. At 1 the root is placed at the location of the source’s retarget root bone.

Type:

(float)

property blend_to_source_weights: Vector

[Read-Write] Blend to Source Weights: Per-axis weights for the Blend to Source.

Type:

(Vector)

property rotation_alpha: float

[Read-Write] Rotation Alpha: Range 0 to 1. Default 1. Blends the amount of retargeted root rotation to apply. At 0 the root is left at the rotation from the retarget pose. At 1 the root is rotated fully to match the source root rotation.

Type:

(float)

property rotation_offset: Rotator

[Read-Write] Rotation Offset: Applies a static local-space rotation offset to the retarget root.

Type:

(Rotator)

property scale_horizontal: float

[Read-Write] Scale Horizontal: Default 1. Scales the motion of the root position in the horizontal plane (X,Y).

Type:

(float)

property scale_vertical: float

[Read-Write] Scale Vertical: Default 1. Scales the motion of the root position in the vertical direction (Z).

Type:

(float)

property translation_alpha: float

[Read-Write] Translation Alpha: Range 0 to 1. Default 1. Blends the amount of retargeted root translation to apply. At 0 the root is left at the position from the retarget pose. At 1 the root will follow the source motion according to the behavior defined in the subsequent settings.

Type:

(float)

property translation_offset: Vector

[Read-Write] Translation Offset: Applies a static component-space translation offset to the retarget root.

Type:

(Vector)