unreal.RetargetProfile

class unreal.RetargetProfile(apply_target_retarget_pose: bool = False, target_retarget_pose_name: Name = 'None', apply_source_retarget_pose: bool = False, source_retarget_pose_name: Name = 'None', apply_chain_settings: bool = False, chain_settings: None = {}, apply_root_settings: bool = False, root_settings: TargetRootSettings = Ellipsis, apply_global_settings: bool = False, global_settings: RetargetGlobalSettings = Ellipsis)

Bases: StructBase

Retarget Profile

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: IKRetargetProfile.h

Editor Properties: (see get_editor_property/set_editor_property)

  • apply_chain_settings (bool): [Read-Write] If true, the Chain Settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter).

  • apply_global_settings (bool): [Read-Write] If true, the global settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter).

  • apply_root_settings (bool): [Read-Write] If true, the root settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter).

  • apply_source_retarget_pose (bool): [Read-Write] If true, the Source Retarget Pose specified in this profile will be applied to the Retargeter (when plugged into the Retargeter).

  • apply_target_retarget_pose (bool): [Read-Write] If true, the TARGET Retarget Pose specified in this profile will be applied to the Retargeter (when plugged into the Retargeter).

  • chain_settings (Map[Name, TargetChainSettings]): [Read-Write] A (potentially sparse) set of setting overrides for the target chains (only applied when bApplyChainSettings is true).

  • global_settings (RetargetGlobalSettings): [Read-Write] Retarget settings to control global behavior, like Stride Warping (not applied unless bApplyGlobalSettings is true)

  • root_settings (TargetRootSettings): [Read-Write] Retarget settings to control behavior of the retarget root motion (not applied unless bApplyRootSettings is true)

  • source_retarget_pose_name (Name): [Read-Write] Override the SOURCE Retarget Pose to use when this profile is active. The pose must be present in the Retarget Asset and is not applied unless bApplySourceRetargetPose is true.

  • target_retarget_pose_name (Name): [Read-Write] Override the TARGET Retarget Pose to use when this profile is active. The pose must be present in the Retarget Asset and is not applied unless bApplyTargetRetargetPose is true.

property apply_chain_settings: bool

[Read-Write] If true, the Chain Settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter).

Type:

(bool)

property apply_global_settings: bool

[Read-Write] If true, the global settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter).

Type:

(bool)

property apply_root_settings: bool

[Read-Write] If true, the root settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter).

Type:

(bool)

property apply_source_retarget_pose: bool

[Read-Write] If true, the Source Retarget Pose specified in this profile will be applied to the Retargeter (when plugged into the Retargeter).

Type:

(bool)

property apply_target_retarget_pose: bool

[Read-Write] If true, the TARGET Retarget Pose specified in this profile will be applied to the Retargeter (when plugged into the Retargeter).

Type:

(bool)

property chain_settings: None

[Read-Write] A (potentially sparse) set of setting overrides for the target chains (only applied when bApplyChainSettings is true).

Type:

(Map[Name, TargetChainSettings])

property global_settings: RetargetGlobalSettings

[Read-Write] Retarget settings to control global behavior, like Stride Warping (not applied unless bApplyGlobalSettings is true)

Type:

(RetargetGlobalSettings)

property root_settings: TargetRootSettings

[Read-Write] Retarget settings to control behavior of the retarget root motion (not applied unless bApplyRootSettings is true)

Type:

(TargetRootSettings)

property source_retarget_pose_name: Name

[Read-Write] Override the SOURCE Retarget Pose to use when this profile is active. The pose must be present in the Retarget Asset and is not applied unless bApplySourceRetargetPose is true.

Type:

(Name)

property target_retarget_pose_name: Name

[Read-Write] Override the TARGET Retarget Pose to use when this profile is active. The pose must be present in the Retarget Asset and is not applied unless bApplyTargetRetargetPose is true.

Type:

(Name)