unreal.IKRetargetFloorConstraintOpSettings

class unreal.IKRetargetFloorConstraintOpSettings(lod_threshold: int = 0, chains_to_affect: None = [], height_falloff_offset: float = 0.0, height_falloff_distance: float = 0.0)

Bases: IKRetargetOpSettingsBase

IKRetarget Floor Constraint Op Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: FloorConstraintOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • chains_to_affect (Array[FloorConstraintChainSettings]): [Read-Write] The per-chain settings (exposed indirectly to the UI through a detail customization)

  • height_falloff_distance (double): [Read-Write] Range 0 to inf. Default is 20. The height in cm from the floor below which the goal is gradually blended towards the source bone height. NOTE: if the source bone is higher than this value, the height of the goal is left at its normal retargeted height.

  • height_falloff_offset (double): [Read-Write] Range 0 to inf. Default is 8. The height in cm from the floor below which the goal is snapped directly to the source bone height. NOTE: if the source bone height is greater than this value, but lower than FloorHeightFalloffEnd, then the height will smoothly blend from the source bone height, to the height of the goal in its normal retargeted position.

  • 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 chains_to_affect: None

[Read-Write] The per-chain settings (exposed indirectly to the UI through a detail customization)

Type:

(Array[FloorConstraintChainSettings])

property height_falloff_distance: float

[Read-Write] Range 0 to inf. Default is 20. The height in cm from the floor below which the goal is gradually blended towards the source bone height. NOTE: if the source bone is higher than this value, the height of the goal is left at its normal retargeted height.

Type:

(double)

property height_falloff_offset: float

[Read-Write] Range 0 to inf. Default is 8. The height in cm from the floor below which the goal is snapped directly to the source bone height. NOTE: if the source bone height is greater than this value, but lower than FloorHeightFalloffEnd, then the height will smoothly blend from the source bone height, to the height of the goal in its normal retargeted position.

Type:

(double)