unreal.BatchRetargetSettings

class unreal.BatchRetargetSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

settings object used in details view of the batch retarget window

C++ Source:

  • Plugin: IKRig

  • Module: IKRigEditor

  • File: SRetargetAnimAssetsWindow.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_generate_retargeter (bool): [Read-Write] When true, the system will attempt to generate an IK Retargeter compatible with the supplied source and target skeletal meshes. If the skeletons are successfully characterized, it will align the retarget poses automatically. Automatic retargeting is currently limited to common, predefined skeleton types that Unreal knows about (see documentation for full list). If you attempt to use a skeletal mesh that is not compatible with a predefined template, warnings will be displayed in the output log and the export button will be disabled. In that case, you must supply a custom retargeter asset.

  • override_set_to_apply (Name): [Read-Write] Override set from the retargeter to apply during preview and export. Only available when using a manually supplied retargeter asset.

  • retarget_asset (IKRetargeter): [Read-Write] You may also supply a custom IK Retargeter if needed.

  • source_skeletal_mesh (SkeletalMesh): [Read-Write] The skeletal mesh with the proportions you want to copy animation FROM.

  • target_skeletal_mesh (SkeletalMesh): [Read-Write] The skeletal mesh with the proportions you want to copy animation TO.

property auto_generate_retargeter: bool

[Read-Write] When true, the system will attempt to generate an IK Retargeter compatible with the supplied source and target skeletal meshes. If the skeletons are successfully characterized, it will align the retarget poses automatically. Automatic retargeting is currently limited to common, predefined skeleton types that Unreal knows about (see documentation for full list). If you attempt to use a skeletal mesh that is not compatible with a predefined template, warnings will be displayed in the output log and the export button will be disabled. In that case, you must supply a custom retargeter asset.

Type:

(bool)

property override_set_to_apply: Name

[Read-Write] Override set from the retargeter to apply during preview and export. Only available when using a manually supplied retargeter asset.

Type:

(Name)

property retarget_asset: IKRetargeter

[Read-Write] You may also supply a custom IK Retargeter if needed.

Type:

(IKRetargeter)

property source_skeletal_mesh: SkeletalMesh

[Read-Write] The skeletal mesh with the proportions you want to copy animation FROM.

Type:

(SkeletalMesh)

property target_skeletal_mesh: SkeletalMesh

[Read-Write] The skeletal mesh with the proportions you want to copy animation TO.

Type:

(SkeletalMesh)