unreal.IKRetargetCurveRemapOpSettings

class unreal.IKRetargetCurveRemapOpSettings(lod_threshold: int = 0, copy_all_source_curves: bool = False, remap_curves: bool = False, curves_to_remap: None = [])

Bases: IKRetargetOpSettingsBase

IKRetarget Curve Remap Op Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: CurveRemapOp.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

  • curves_to_remap (Array[CurveRemapPair]): [Read-Write] Add pairs of Source/Target curve names to remap. While retargeting, the animation from the source curves will be redirected to the curves on the target skeletal meshes. Can be used to drive, blendshapes or other downstream systems. NOTE: By default the IK Retargeter will automatically copy all equivalently named curves from the source to the target. Remapping is only necessary when the target curve name(s) are different.

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

  • remap_curves (bool): [Read-Write] Toggle curve remapping on/off

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

Type:

(bool)

property curves_to_remap: None

[Read-Write] Add pairs of Source/Target curve names to remap. While retargeting, the animation from the source curves will be redirected to the curves on the target skeletal meshes. Can be used to drive, blendshapes or other downstream systems. NOTE: By default the IK Retargeter will automatically copy all equivalently named curves from the source to the target. Remapping is only necessary when the target curve name(s) are different.

Type:

(Array[CurveRemapPair])

property remap_curves: bool

[Read-Write] Toggle curve remapping on/off

Type:

(bool)