unreal.IKRetargetRigMapperOpSettings

class unreal.IKRetargetRigMapperOpSettings(enabled: bool = False, lod_threshold: int = 0, copy_all_source_curves: bool = False, definition: RigMapperDefinition = Ellipsis, override_from_user_data_definitions: bool = False)

Bases: IKRetargetRigMapperOpSettingsBase

Single Definition RigMapper 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.

  • definition (RigMapperDefinition): [Read-Write] User defined RigMapper definition

  • definitions (Array[RigMapperDefinition]): [Read-Write] TODO: Remove in UE 5.8 deprecated: Use Definition instead

  • enabled (bool): [Read-Write] Enable/disable the entire operation. Disabled ops are skipped entirely and do not run at all.

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

  • override_from_user_data_definitions (bool): [Read-Write] Whether should RigMapper definition be overridden with the array of definitions from target skeletal mesh UserData NOTE: Should not be used if there are multiple single RigMapper ops in the sequence

property definition: RigMapperDefinition

[Read-Write] User defined RigMapper definition

Type:

(RigMapperDefinition)

property definitions: None

Remove in UE 5.8 deprecated: Use Definition instead

Type:

(Array[RigMapperDefinition])

Type:

[Read-Write] TODO

property override_from_user_data_definitions: bool

[Read-Write] Whether should RigMapper definition be overridden with the array of definitions from target skeletal mesh UserData NOTE: Should not be used if there are multiple single RigMapper ops in the sequence

Type:

(bool)