unreal.IKRetargetSpeedPlantingOpSettings¶
- class unreal.IKRetargetSpeedPlantingOpSettings(enabled: bool = False, lod_threshold: int = 0, chains_to_speed_plant: None = [], alpha: float = 0.0, speed_threshold: float = 0.0, blend_method: SpeedPlantBlendMethod = Ellipsis, max_blend_speed: float = 0.0, time_to_max_speed: float = 0.0, arrival_speed_gain: float = 0.0, spring_strength: float = 0.0, debug_draw_size: float = 0.0)¶
Bases:
IKRetargetOpSettingsBaseSpeed Plant Settings
C++ Source:
Plugin: IKRig
Module: IKRig
File: SpeedPlantingOp.h
Editor Properties: (see get_editor_property/set_editor_property)
alpha(float): [Read-Write] Range 0 to 1. Default 1. Blends the effect of the speed planting. At 0, there is no effect.arrival_speed_gain(double): [Read-Write] Controls how aggressively the goal velocity matches the animated velocity as it arrives at the animated location after unplanting. This allows the goal speed to gradually blend towards the target speed as the goal location approaches the animated location. Reduce this to remove velocity discontinuities when catching up to the animation. 1.0 is very soft, 20.0 is very sharp. Default is 10.0.blend_method(SpeedPlantBlendMethod): [Read-Write] The method to use when blending the IK goal in/out of a planted position. The Spring method uses a critically damped spring equation to blend into and out of the planted states. The Move Towards method can more accurately track fast motion without looking mushy. It only blends out of planted states.chains_to_speed_plant(Array[RetargetSpeedPlantingSettings]): [Read-Write]debug_draw_size(double): [Read-Write] Adjust size of goal debug drawing in viewport. Red is planted, green is unplanted.enabled(bool): [Read-Write] Enable/disable the entire operation. Disabled ops are skipped entirely and do not run at all.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.max_blend_speed(double): [Read-Write] The maximum speed in cm/s that the goal will move to catch up to the animation after unplanting. This blended towards the animated velocity as the goal catches up to animated location after unplanting.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.spring_strength(double): [Read-Write] The spring strength determines how hard it will pull towards the target when planting and unplanting. The value is the frequency (hz) at which it will oscillate when there is no damping.stiffness(double): [Read-Write] Deprecated in 5.8, replaced with higher-level “Strength” param deprecated: Property ‘Stiffness’ is deprecated.time_to_max_speed(double): [Read-Write] Seconds to reach MaxBlendSpeed. Determines how rapidly the goal accelerates after unplanting.
- property alpha: float¶
[Read-Write] Range 0 to 1. Default 1. Blends the effect of the speed planting. At 0, there is no effect.
- Type:
(float)
- property arrival_speed_gain: float¶
[Read-Write] Controls how aggressively the goal velocity matches the animated velocity as it arrives at the animated location after unplanting. This allows the goal speed to gradually blend towards the target speed as the goal location approaches the animated location. Reduce this to remove velocity discontinuities when catching up to the animation. 1.0 is very soft, 20.0 is very sharp. Default is 10.0.
- Type:
(double)
- property blend_method: SpeedPlantBlendMethod¶
[Read-Write] The method to use when blending the IK goal in/out of a planted position. The Spring method uses a critically damped spring equation to blend into and out of the planted states. The Move Towards method can more accurately track fast motion without looking mushy. It only blends out of planted states.
- Type:
- property debug_draw_size: float¶
[Read-Write] Adjust size of goal debug drawing in viewport. Red is planted, green is unplanted.
- Type:
(double)
- property max_blend_speed: float¶
[Read-Write] The maximum speed in cm/s that the goal will move to catch up to the animation after unplanting. This blended towards the animated velocity as the goal catches up to animated location after unplanting.
- 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 spring_strength: float¶
[Read-Write] The spring strength determines how hard it will pull towards the target when planting and unplanting. The value is the frequency (hz) at which it will oscillate when there is no damping.
- Type:
(double)