Merge pull request #1106 from acemod/refactorCalcWindSpeed

Moved all wind calculations into the weather module

addons/advanced_ballistics/XEH_preInit.sqf

@@ -6,9 +6,7 @@ PREP(calculateAmmoTemperatureVelocityShift);
 PREP(calculateAtmosphericCorrection);
 PREP(calculateBarrelLengthVelocityShift);
 PREP(calculateRetardation);
-PREP(calculateRoughnessLength);
 PREP(calculateStabilityFactor);
-PREP(calculateWindSpeed);
 PREP(displayProtractor);
 PREP(handleFired);
 PREP(initializeTerrainExtension);

addons/advanced_ballistics/functions/fnc_calculateWindSpeed.sqf

@@ -1,78 +0,0 @@
-/*
- * Author: Ruthberg
- *
- * Calculates the true wind speed at a given world position
- *
- * Arguments:
- * 0: _this - world position <posASL>
- *
- * Return Value:
- * 0: wind speed - m/s <NUMBER>
- *
- * Public: No
- */
-#include "script_component.hpp"
-
-private ["_windSpeed", "_windDir", "_height", "_newWindSpeed", "_windSource", "_roughnessLength"];
-
-fnc_polar2vect = {
-    private ["_mag2D"];
-    _mag2D = (_this select 0) * cos((_this select 2));
-    [_mag2D * sin((_this select 1)), _mag2D * cos((_this select 1)), (_this select 0) * sin((_this select 2))];
-};
-
-_windSpeed = vectorMagnitude ACE_wind;
-_windDir = (ACE_wind select 0) atan2 (ACE_wind select 1);
-
-// Wind gradient
-if (_windSpeed > 0.05) then {
-    _height = (ASLToATL _this) select 2;
-    _height = 0 max _height min 20;
-    if (_height < 20) then {
-        _roughnessLength = _this call FUNC(calculateRoughnessLength);
-        _windSpeed = _windSpeed * ln(_height / _roughnessLength) / ln(20 / _roughnessLength);
-    };
-};
-
-// Terrain effect on wind
-if (_windSpeed > 0.05) then {
-    _newWindSpeed = 0;
-    {
-        _windSource = [100, _windDir + 180, _x] call fnc_polar2vect;
-        if (!(terrainIntersectASL [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 9) * _windSpeed;
-        };
-        _windSource = [100, _windDir + 180 + _x, 0] call fnc_polar2vect;
-        if (!(terrainIntersectASL [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 9) * _windSpeed;
-        };
-        _windSource = [100, _windDir + 180 - _x, 0] call fnc_polar2vect;
-        if (!(terrainIntersectASL [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 9) * _windSpeed;
-        };
-    } forEach [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
-    _windSpeed = _newWindSpeed;
-};
-
-// Obstacle effect on wind
-if (_windSpeed > 0.05) then {
-    _newWindSpeed = 0;
-    {
-        _windSource = [20, _windDir + 180, _x] call fnc_polar2vect;
-        if (!(lineIntersects [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 2) * _windSpeed;
-        };
-        _windSource = [20, _windDir + 180 + _x, 0] call fnc_polar2vect;
-        if (!(lineIntersects [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 2) * _windSpeed;
-        };
-        _windSource = [20, _windDir + 180 - _x, 0] call fnc_polar2vect;
-        if (!(lineIntersects [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 2) * _windSpeed;
-        };
-    } forEach [0, 5, 10, 15, 20, 25, 30, 35, 40, 45];
-    _windSpeed = _newWindSpeed;
-};
-_windSpeed = 0 max _windSpeed;
-
-_windSpeed

addons/kestrel4500/XEH_preInit.sqf

@@ -3,7 +3,6 @@
 ADDON = false;
 
 PREP(buttonPressed);
-PREP(calculateWindSpeed);
 PREP(canShow);
 PREP(collectData);
 PREP(createKestrelDialog);

addons/kestrel4500/functions/fnc_calculateWindSpeed.sqf

@@ -1,68 +0,0 @@
-/*
- * Author: Ruthberg
- *
- * Calculates the wind speed at a given world position
- *
- * Arguments:
- * 0: _this - world position <posASL>
- *
- * Return Value:
- * 0: wind speed - m/s <NUMBER>
- *
- * Public: No
- */
-#include "script_component.hpp"
-
-private ["_windSpeed", "_windDir", "_newWindSpeed", "_windSource"];
-
-fnc_polar2vect = {
-    private ["_mag2D"];
-    _mag2D = (_this select 0) * cos((_this select 2));
-    [_mag2D * sin((_this select 1)), _mag2D * cos((_this select 1)), (_this select 0) * sin((_this select 2))];
-};
-
-_windSpeed = vectorMagnitude ACE_wind;
-_windDir = (ACE_wind select 0) atan2 (ACE_wind select 1);
-
-// Terrain effect on wind
-if (_windSpeed > 0.05) then {
-    _newWindSpeed = 0;
-    {
-        _windSource = [100, _windDir + 180, _x] call fnc_polar2vect;
-        if (!(terrainIntersectASL [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 9) * _windSpeed;
-        };
-        _windSource = [100, _windDir + 180 + _x, 0] call fnc_polar2vect;
-        if (!(terrainIntersectASL [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 9) * _windSpeed;
-        };
-        _windSource = [100, _windDir + 180 - _x, 0] call fnc_polar2vect;
-        if (!(terrainIntersectASL [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 9) * _windSpeed;
-        };
-    } forEach [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
-    _windSpeed = _newWindSpeed;
-};
-
-// Obstacle effect on wind
-if (_windSpeed > 0.05) then {
-    _newWindSpeed = 0;
-    {
-        _windSource = [20, _windDir + 180, _x] call fnc_polar2vect;
-        if (!(lineIntersects [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 2) * _windSpeed;
-        };
-        _windSource = [20, _windDir + 180 + _x, 0] call fnc_polar2vect;
-        if (!(lineIntersects [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 2) * _windSpeed;
-        };
-        _windSource = [20, _windDir + 180 - _x, 0] call fnc_polar2vect;
-        if (!(lineIntersects [_this, _this vectorAdd _windSource])) exitWith {
-            _newWindSpeed = cos(_x * 2) * _windSpeed;
-        };
-    } forEach [0, 5, 10, 15, 20, 25, 30, 35, 40, 45];
-    _windSpeed = _newWindSpeed;
-};
-_windSpeed = 0 max _windSpeed;
-
-_windSpeed

addons/kestrel4500/functions/fnc_measureWindSpeed.sqf

@@ -19,12 +19,13 @@ private ["_playerDir", "_windSpeed", "_windDir"];
 _playerDir = getDir ACE_player;
 _windSpeed = vectorMagnitude ACE_wind;
 _windDir = (ACE_wind select 0) atan2 (ACE_wind select 1);
-
 if (missionNamespace getVariable [QEGVAR(advanced_ballistics,enabled), false]) then {
-    _windSpeed = (eyePos ACE_player) call EFUNC(advanced_ballistics,calculateWindSpeed);
+    // With wind gradient
+    _windSpeed = [eyePos ACE_player, true, true, true] call EFUNC(weather,calculateWindSpeed);
     _windSpeed = abs(cos(_playerDir - _windDir)) * _windSpeed;
 } else {
-    _windSpeed = (eyePos ACE_player) call FUNC(calculateWindSpeed);
+    // Without wind gradient
+    _windSpeed = [eyePos ACE_player, false, true, true] call EFUNC(weather,calculateWindSpeed);
 };
 
 if (_windSpeed > 0.3 || {GVAR(MeasuredWindSpeed) > 0.1 && _windSpeed > 0.125}) then {

addons/weather/XEH_preInit.sqf

@@ -5,6 +5,8 @@ ADDON = false;
 
 PREP(calculateAirDensity);
 PREP(calculateBarometricPressure);
+PREP(calculateRoughnessLength);
+PREP(calculateWindSpeed);
 PREP(displayWindInfo);
 PREP(getMapData);
 PREP(getWind);

addons/weather/config.cpp

@@ -5,8 +5,8 @@ class CfgPatches {
         units[] = {};
         weapons[] = {};
         requiredVersion = REQUIRED_VERSION;
-        requiredAddons[] = {"ace_common"};
-        author[] = {"q1184", "Rocko", "esteldunedain","Ruthberg"};
+        requiredAddons[] = {"ace_common", "ace_modules"};
+        author[] = {"q1184", "Rocko", "esteldunedain", "Ruthberg"};
         VERSION_CONFIG;
     };
 };

addons/weather/functions/fnc_calculateWindSpeed.sqf

@@ -0,0 +1,90 @@
+/*
+ * Author: Ruthberg
+ *
+ * Calculates the true wind speed at a given world position
+ *
+ * Arguments:
+ * 0: world position - posASL <POSTION>
+ * 1: Account for wind gradient <BOOL>
+ * 2: Account for terrain <BOOL>
+ * 3: Account for obstacles <BOOL>
+ *
+ * Return Value:
+ * 0: wind speed - m/s <NUMBER>
+ *
+ * Public: No
+ */
+#include "script_component.hpp"
+
+private ["_windSpeed", "_windDir", "_height", "_newWindSpeed", "_windSource", "_roughnessLength"];
+
+EXPLODE_4_PVT(_this,_position,_windGradientEnabled,_terrainEffectEnabled,_obstacleEffectEnabled);
+
+fnc_polar2vect = {
+    private ["_mag2D"];
+    _mag2D = (_this select 0) * cos((_this select 2));
+    [_mag2D * sin((_this select 1)), _mag2D * cos((_this select 1)), (_this select 0) * sin((_this select 2))];
+};
+
+_windSpeed = vectorMagnitude ACE_wind;
+_windDir = (ACE_wind select 0) atan2 (ACE_wind select 1);
+
+// Wind gradient
+if (_windGradientEnabled) then {
+    if (_windSpeed > 0.05) then {
+        _height = (ASLToATL _position) select 2;
+        _height = 0 max _height min 20;
+        if (_height < 20) then {
+            _roughnessLength = _position call FUNC(calculateRoughnessLength);
+            _windSpeed = _windSpeed * abs(ln(_height / _roughnessLength) / ln(20 / _roughnessLength));
+        };
+    };
+};
+
+// Terrain effect on wind
+if (_terrainEffectEnabled) then {
+    if (_windSpeed > 0.05) then {
+        _newWindSpeed = 0;
+        {
+            _windSource = [100, _windDir + 180, _x] call fnc_polar2vect;
+            if (!(terrainIntersectASL [_position, _position vectorAdd _windSource])) exitWith {
+                _newWindSpeed = cos(_x * 9) * _windSpeed;
+            };
+            _windSource = [100, _windDir + 180 + _x, 0] call fnc_polar2vect;
+            if (!(terrainIntersectASL [_position, _position vectorAdd _windSource])) exitWith {
+                _newWindSpeed = cos(_x * 9) * _windSpeed;
+            };
+            _windSource = [100, _windDir + 180 - _x, 0] call fnc_polar2vect;
+            if (!(terrainIntersectASL [_position, _position vectorAdd _windSource])) exitWith {
+                _newWindSpeed = cos(_x * 9) * _windSpeed;
+            };
+        } forEach [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+        _windSpeed = _newWindSpeed;
+    };
+};
+
+// Obstacle effect on wind
+if (_obstacleEffectEnabled) then {
+    if (_windSpeed > 0.05) then {
+        _newWindSpeed = 0;
+        {
+            _windSource = [20, _windDir + 180, _x] call fnc_polar2vect;
+            if (!(lineIntersects [_position, _position vectorAdd _windSource])) exitWith {
+                _newWindSpeed = cos(_x * 2) * _windSpeed;
+            };
+            _windSource = [20, _windDir + 180 + _x, 0] call fnc_polar2vect;
+            if (!(lineIntersects [_position, _position vectorAdd _windSource])) exitWith {
+                _newWindSpeed = cos(_x * 2) * _windSpeed;
+            };
+            _windSource = [20, _windDir + 180 - _x, 0] call fnc_polar2vect;
+            if (!(lineIntersects [_position, _position vectorAdd _windSource])) exitWith {
+                _newWindSpeed = cos(_x * 2) * _windSpeed;
+            };
+        } forEach [0, 5, 10, 15, 20, 25, 30, 35, 40, 45];
+        _windSpeed = _newWindSpeed;
+    };
+};
+
+_windSpeed = 0 max _windSpeed;
+
+_windSpeed

addons/weather/functions/fnc_displayWindInfo.sqf

@@ -38,15 +38,14 @@ GVAR(WindInfo) = true;
 
     _windIndex = 12;
     _windColor = [1, 1, 1, 1];
-
-    // Toogle behaviour depending on ace_advanced_ballistics being used or not
-    // @todo, check ACE_AB is actually enabled
-    _windSpeed = if (isClass (configFile >> "CfgPatches" >> "ACE_Advanced_Ballistics")) then {
-        (eyePos ACE_player) call EFUNC(advanced_ballistics,calculateWindSpeed);
+    _windSpeed = if (missionNamespace getVariable [QEGVAR(advanced_ballistics,enabled), false]) then {
+        // With wind gradient
+        [eyePos ACE_player, true, true, true] call FUNC(calculateWindSpeed);
     } else {
-        vectorMagnitude ACE_wind;
+        // Without wind gradient
+        [eyePos ACE_player, false, true, true] call FUNC(calculateWindSpeed);
     };
-
+    
     if (_windSpeed > 0.2) then {
         _playerDir = getDir ACE_player;
         _windDir = (ACE_wind select 0) atan2 (ACE_wind select 1);