unreal.RetargetProfile

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

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]

  • apply_global_settings (bool): [Read-Write]

  • apply_root_settings (bool): [Read-Write]

  • 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]

  • force_all_ik_off (bool): [Read-Write] Globally forces all IK solving off

  • global_settings (RetargetGlobalSettings): [Read-Write]

  • retarget_op_profiles (Array[RetargetOpProfile]): [Read-Write] A polymorphic list of override settings to apply to retargeting operations in the stack

  • root_settings (TargetRootSettings): [Read-Write]

  • 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]

Type:

(bool)

property apply_global_settings: bool

[Read-Write]

Type:

(bool)

property apply_root_settings: bool

[Read-Write]

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]

Type:

(Map[Name, TargetChainSettings])

property force_all_ik_off: bool

[Read-Write] Globally forces all IK solving off

Type:

(bool)

property global_settings: RetargetGlobalSettings

[Read-Write]

Type:

(RetargetGlobalSettings)

property retarget_op_profiles: None

[Read-Write] A polymorphic list of override settings to apply to retargeting operations in the stack

Type:

(Array[RetargetOpProfile])

property root_settings: TargetRootSettings

[Read-Write]

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)