unreal.TargetChainSpeedPlantSettings

class unreal.TargetChainSpeedPlantSettings(enable_speed_planting: bool = False, speed_curve_name: Name = 'None', speed_threshold: float = 0.0, unplant_stiffness: float = 0.0, unplant_critical_damping: float = 0.0)

Bases: StructBase

Target Chain Speed Plant Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: IKRetargetSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • enable_speed_planting (bool): [Read-Write] Enable Speed Planting: The name of the curve on the source animation that contains the speed of the end effector bone.

  • speed_curve_name (Name): [Read-Write] Speed Curve Name: The name of the curve on the source animation that contains the speed of the end effector bone.

  • speed_threshold (float): [Read-Write] Speed Threshold: Range 0 to 1000. 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.

  • unplant_critical_damping (float): [Read-Write] Unplant Critical Damping: How much damping to apply to the spring (0 means no damping, 1 means critically damped which means no oscillation)

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

property enable_speed_planting: bool

[Read-Write] Enable Speed Planting: The name of the curve on the source animation that contains the speed of the end effector bone.

Type:

(bool)

property speed_curve_name: Name

[Read-Write] Speed Curve Name: The name of the curve on the source animation that contains the speed of the end effector bone.

Type:

(Name)

property speed_threshold: float

[Read-Write] Speed Threshold: Range 0 to 1000. 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:

(float)

property unplant_critical_damping: float

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

Type:

(float)

property unplant_stiffness: float

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

Type:

(float)