unreal.IKRetargetRigMapperOpSettings

class unreal.IKRetargetRigMapperOpSettings(lod_threshold: int = 0, copy_all_source_curves: bool = False, definitions: None = [])

Bases: IKRetargetOpSettingsBase

IKRetarget Rig Mapper Op Settings

C++ Source:

  • Plugin: RigMapperOp

  • Module: RigMapperOp

  • File: RigMapperOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • copy_all_source_curves (bool): [Read-Write] Whether to copy all curves over to the target animation instance NOTE: This setting also applies when exporting retargeted animations. True: all source curves are copied to the target animation instance/asset False: only remapped curves are copied on the target animation instance/asset In general, we should set this to true if the source and target rig are the same, and the RigMapper covers only a subset of the controls, but false otherwise.

  • definitions (Array[RigMapperDefinition]): [Read-Write]

  • lod_threshold (int32): [Read-Write] The maximum LOD that this Op is allowed to run at. For example if you have LODThreshold of 2, the Op will run until LOD 2 (based on 0 index). When the component LOD becomes 3, it will stop running. A value of -1 forces the Op to execute at all LOD levels. Default is -1.

property copy_all_source_curves: bool

[Read-Write] Whether to copy all curves over to the target animation instance NOTE: This setting also applies when exporting retargeted animations. True: all source curves are copied to the target animation instance/asset False: only remapped curves are copied on the target animation instance/asset In general, we should set this to true if the source and target rig are the same, and the RigMapper covers only a subset of the controls, but false otherwise.

Type:

(bool)

property definitions: None

[Read-Write]

Type:

(Array[RigMapperDefinition])