unreal.IKRetargetFilterBoneOpSettings

class unreal.IKRetargetFilterBoneOpSettings(enabled: bool = False, lod_threshold: int = 0, bones_to_filter: None = [], alpha: float = 0.0, filter_settings: OneEuroFilterSettings = Ellipsis, reset_playback: bool = False)

Bases: IKRetargetOpSettingsBase

Filter Bone Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: FilterBoneOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • alpha (double): [Read-Write] Range 0 to 1. Default 1. Blends the effect of the entire op.

  • bones_to_filter (Array[FilterBoneData]): [Read-Write] A list of bone-pairs to copy transforms between

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

  • filter_settings (OneEuroFilterSettings): [Read-Write] The settings to control the One-Euro filter behavior

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

  • reset_playback (bool): [Read-Write] If true, filter is reset when playback loops.

property alpha: float

[Read-Write] Range 0 to 1. Default 1. Blends the effect of the entire op.

Type:

(double)

property bones_to_filter: None

[Read-Write] A list of bone-pairs to copy transforms between

Type:

(Array[FilterBoneData])

property filter_settings: OneEuroFilterSettings

[Read-Write] The settings to control the One-Euro filter behavior

Type:

(OneEuroFilterSettings)

property reset_playback: bool

[Read-Write] If true, filter is reset when playback loops.

Type:

(bool)