refactor: Improved field names and removed unused field

Author: twpol

Source/Orts.Simulation/Simulation/Physics/Train.cs

@@ -2116,8 +2116,8 @@ public void UpdateWindComponents()
             // Wind and train direction to be converted to an angle between 0 and 360 deg.
                 // Calculate Wind speed and direction, and train direction
                 // Update the value of the Wind Speed and Direction for the train
-                PhysicsWindDirectionDeg = MathHelper.ToDegrees(Simulator.Weather.WindDirection);
-                PhysicsWindSpeedMpS = Simulator.Weather.WindSpeed;
+                PhysicsWindDirectionDeg = MathHelper.ToDegrees(Simulator.Weather.WindDirectionRad);
+                PhysicsWindSpeedMpS = Simulator.Weather.WindSpeedMpS.Length();
                 float TrainSpeedMpS = Math.Abs(SpeedMpS);
 
                 // If a westerly direction (ie -ve) convert to an angle between 0 and 360

Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs

@@ -3117,7 +3117,7 @@ public virtual void UpdateFrictionCoefficient(float elapsedClockSeconds)
                 }
 
                 // Adjust adhesion for impact of fog - default = 20000m = 20km
-                float fog = Simulator.Weather.FogDistance;
+                float fog = Simulator.Weather.VisibilityM;
                 if (fog < 20000) // as fog thickens then decrease adhesion
                 {
                     fogBaseFrictionCoefficientFactor = Math.Min((fog * 2.75e-4f + 0.6f), 1.0f); // If fog is less then 2km then it will impact friction, decrease adhesion to 60% (same as light rain transition)

Source/Orts.Simulation/Simulation/Weather.cs

@@ -1,4 +1,4 @@
-// COPYRIGHT 2010, 2011, 2014, 2015 by the Open Rails project.
+// COPYRIGHT 2009 - 2023 by the Open Rails project.
 //
 // This file is part of Open Rails.
 //
@@ -15,6 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
 
+using System;
 using Microsoft.Xna.Framework;
 
 namespace Orts.Simulation
@@ -34,24 +35,20 @@ public class Weather
         //   Moderate     0.5-1.0km
         //   Heavy       <0.5km
 
-        // Overcast factor: 0.0 = almost no clouds; 0.1 = wispy clouds; 1.0 = total overcast.
-        public float OvercastFactor;
+        // Fog/visibility distance. Ranges from 10m (can't see anything), 5km (medium), 20km (clear) to 100km (clear arctic).
+        public float VisibilityM;
+
+        // Cloud cover factor: 0.0 = almost no clouds; 0.1 = wispy clouds; 1.0 = total overcast.
+        public float CloudCoverFactor;
 
         // Precipitation intensity in particles per second per meter^2 (PPSPM2).
         public float PrecipitationIntensityPPSPM2;
 
-        // Fog/visibility distance. Ranges from 10m (can't see anything), 5km (medium), 20km (clear) to 100km (clear arctic).
-        public float FogDistance;
-
-        // Precipitation liquidity; =1 for rain, =0 for snow; intermediate values possible with dynamic weather;
+        // Precipitation liquidity; 1 = rain, 0 = snow; intermediate values possible with dynamic weather.
         public float PrecipitationLiquidity;
 
-        public float CalculatedWindDirection;
-
         public Vector2 WindSpeedMpS;
 
-        public float WindSpeed => WindSpeedMpS.Length();
-
-        public float WindDirection => CalculatedWindDirection;
+        public float WindDirectionRad => (float)Math.Atan2(WindSpeedMpS.X, WindSpeedMpS.Y);
     }
 }

Source/RunActivity/Viewer3D/MSTSSky.cs

@@ -150,7 +150,7 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
                     mstsskymoonPhase = 3; // Moon dog only occurs in winter
                 // Overcast factor: 0.0=almost no clouds; 0.1=wispy clouds; 1.0=total overcast
                 //mstsskyovercastFactor = MSTSSkyViewer.World.WeatherControl.overcastFactor;
-                mstsskyfogDistance = MSTSSkyViewer.Simulator.Weather.FogDistance;
+                mstsskyfogDistance = MSTSSkyViewer.Simulator.Weather.VisibilityM;
             }
 
             MPManager manager = MPManager.Instance();

Source/RunActivity/Viewer3D/Materials.cs

@@ -534,16 +534,16 @@ internal void UpdateShaders()
             // End headlight illumination
             if (Viewer.Settings.UseMSTSEnv == false)
             {
-                SceneryShader.Overcast = Viewer.Simulator.Weather.OvercastFactor;
-                SceneryShader.SetFog(Viewer.Simulator.Weather.FogDistance, ref SharedMaterialManager.FogColor);
-                ParticleEmitterShader.SetFog(Viewer.Simulator.Weather.FogDistance, ref SharedMaterialManager.FogColor);
+                SceneryShader.Overcast = Viewer.Simulator.Weather.CloudCoverFactor;
+                SceneryShader.SetFog(Viewer.Simulator.Weather.VisibilityM, ref SharedMaterialManager.FogColor);
+                ParticleEmitterShader.SetFog(Viewer.Simulator.Weather.VisibilityM, ref SharedMaterialManager.FogColor);
                 SceneryShader.ViewerPos = Viewer.Camera.XnaLocation(Viewer.Camera.CameraWorldLocation);
             }
             else
             {
                 SceneryShader.Overcast = Viewer.World.MSTSSky.mstsskyovercastFactor;
                 SceneryShader.SetFog(Viewer.World.MSTSSky.mstsskyfogDistance, ref SharedMaterialManager.FogColor);
-                ParticleEmitterShader.SetFog(Viewer.Simulator.Weather.FogDistance, ref SharedMaterialManager.FogColor);
+                ParticleEmitterShader.SetFog(Viewer.Simulator.Weather.VisibilityM, ref SharedMaterialManager.FogColor);
                 SceneryShader.ViewerPos = Viewer.Camera.XnaLocation(Viewer.Camera.CameraWorldLocation);
             }
         }

Source/RunActivity/Viewer3D/Popups/HUDWindow.cs

@@ -1322,11 +1322,12 @@ void TextPageWeather(TableData table)
             TableSetLabelValueColumns(table, 0, 2);
             TextPageHeading(table, Viewer.Catalog.GetString("WEATHER INFORMATION"));
 
-            TableAddLabelValue(table, Viewer.Catalog.GetString("Visibility"), Viewer.Catalog.GetStringFmt("{0:N0} m", Viewer.Simulator.Weather.FogDistance));
-            TableAddLabelValue(table, Viewer.Catalog.GetString("Cloud cover"), Viewer.Catalog.GetStringFmt("{0:F0} %", Viewer.Simulator.Weather.OvercastFactor * 100));
+            TableAddLabelValue(table, Viewer.Catalog.GetString("Visibility"), Viewer.Catalog.GetStringFmt("{0:N0} m", Viewer.Simulator.Weather.VisibilityM));
+            TableAddLabelValue(table, Viewer.Catalog.GetString("Cloud cover"), Viewer.Catalog.GetStringFmt("{0:F0} %", Viewer.Simulator.Weather.CloudCoverFactor * 100));
             TableAddLabelValue(table, Viewer.Catalog.GetString("Intensity"), Viewer.Catalog.GetStringFmt("{0:F4} p/s/m^2", Viewer.Simulator.Weather.PrecipitationIntensityPPSPM2));
             TableAddLabelValue(table, Viewer.Catalog.GetString("Liquidity"), Viewer.Catalog.GetStringFmt("{0:F0} %", Viewer.Simulator.Weather.PrecipitationLiquidity * 100));
             TableAddLabelValue(table, Viewer.Catalog.GetString("Wind"), Viewer.Catalog.GetStringFmt("{0:F1},{1:F1} m/s", Viewer.Simulator.Weather.WindSpeedMpS.X, Viewer.Simulator.Weather.WindSpeedMpS.Y));
+            // TODO: Move ambient temperature into Orts.Simulation.Weather
             TableAddLabelValue(table, Viewer.Catalog.GetString("Amb Temp"), FormatStrings.FormatTemperature(Viewer.PlayerLocomotive.CarOutsideTempC, Viewer.PlayerLocomotive.IsMetric, false));
         }
 

Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs

@@ -1498,7 +1498,7 @@ int round(float x)
             if (_Shader != null)
             {
                 // TODO: Readd ability to control night time lighting.
-                float overcast = _Viewer.Settings.UseMSTSEnv ? _Viewer.World.MSTSSky.mstsskyovercastFactor : _Viewer.Simulator.Weather.OvercastFactor;
+                float overcast = _Viewer.Settings.UseMSTSEnv ? _Viewer.World.MSTSSky.mstsskyovercastFactor : _Viewer.Simulator.Weather.CloudCoverFactor;
                 _Shader.SetData(_Viewer.MaterialManager.sunDirection, _isNightTexture, false, overcast);
                 _Shader.SetTextureData(cabRect.Left, cabRect.Top, cabRect.Width, cabRect.Height);
                 _Shader.CurrentTechnique.Passes[0].Apply();

Source/RunActivity/Viewer3D/Signals.cs

@@ -357,7 +357,7 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime, Matrix xnaT
                         isDay = Viewer.World.Sky.SolarDirection.Y > 0;
                     else
                         isDay = Viewer.World.MSTSSky.mstsskysolarDirection.Y > 0;
-                    bool isPoorVisibility = Viewer.Simulator.Weather.FogDistance < 200;
+                    bool isPoorVisibility = Viewer.Simulator.Weather.VisibilityM < 200;
                     if (!SignalTypeData.DayLight && isDay && !isPoorVisibility)
                         continue;
 

Source/RunActivity/Viewer3D/Sky.cs

@@ -378,7 +378,7 @@ public SkyMaterial(Viewer viewer)
         public override void Render(GraphicsDevice graphicsDevice, IEnumerable<RenderItem> renderItems, ref Matrix XNAViewMatrix, ref Matrix XNAProjectionMatrix)
         {
             // Adjust Fog color for day-night conditions and overcast
-            FogDay2Night(Viewer.World.Sky.SolarDirection.Y, Viewer.Simulator.Weather.OvercastFactor);
+            FogDay2Night(Viewer.World.Sky.SolarDirection.Y, Viewer.Simulator.Weather.CloudCoverFactor);
 
             // TODO: Use a dirty flag to determine if it is necessary to set the texture again
             SkyShader.StarMapTexture = Viewer.World.Sky.Latitude > 0 ? StarTextureN : StarTextureS;
@@ -387,8 +387,8 @@ public override void Render(GraphicsDevice graphicsDevice, IEnumerable<RenderIte
             SkyShader.LightVector = Viewer.World.Sky.SolarDirection;
             SkyShader.Time = (float)Viewer.Simulator.ClockTime / 100000;
             SkyShader.MoonScale = SkyPrimitive.RadiusM / 20;
-            SkyShader.Overcast = Viewer.Simulator.Weather.OvercastFactor;
-            SkyShader.SetFog(Viewer.Simulator.Weather.FogDistance, ref SharedMaterialManager.FogColor);
+            SkyShader.Overcast = Viewer.Simulator.Weather.CloudCoverFactor;
+            SkyShader.SetFog(Viewer.Simulator.Weather.VisibilityM, ref SharedMaterialManager.FogColor);
             SkyShader.WindSpeed = Viewer.World.Sky.WindSpeed;
             SkyShader.WindDirection = Viewer.World.Sky.WindDirection; // Keep setting this after Time and Windspeed. Calculating displacement here.