unreal.IKRetargetSpeedPlantingOpSettings

class unreal.IKRetargetSpeedPlantingOpSettings(lod_threshold: int = 0, chains_to_speed_plant: None = [], speed_threshold: float = 0.0, stiffness: float = 0.0, critical_damping: float = 0.0)

Bases: IKRetargetOpSettingsBase

IKRetarget Speed Planting Op Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: SpeedPlantingOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • chains_to_speed_plant (Array[RetargetSpeedPlantingSettings]): [Read-Write]

  • critical_damping (double): [Read-Write] How much damping to apply to the spring (0 means no damping, 1 means critically damped which means no oscillation)

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

  • speed_threshold (double): [Read-Write] Range 0 to 100. Default 15. The maximum speed a source bone can be moving while being considered ‘planted’. The target IK goal will not be allowed to move whenever the source bone speed drops below this threshold speed.

  • stiffness (double): [Read-Write] How stiff the spring model is that smoothly pulls the IK position after unplanting (more stiffness means more oscillation around the target value)

property chains_to_speed_plant: None

[Read-Write]

Type:

(Array[RetargetSpeedPlantingSettings])

property critical_damping: float

[Read-Write] How much damping to apply to the spring (0 means no damping, 1 means critically damped which means no oscillation)

Type:

(double)

property speed_threshold: float

[Read-Write] Range 0 to 100. Default 15. The maximum speed a source bone can be moving while being considered ‘planted’. The target IK goal will not be allowed to move whenever the source bone speed drops below this threshold speed.

Type:

(double)

property stiffness: float

[Read-Write] How stiff the spring model is that smoothly pulls the IK position after unplanting (more stiffness means more oscillation around the target value)

Type:

(double)