Merge branch 'openrails:master' into spanish-localization

paladini-maker · web-flow · commit 357239285efa · 2022-04-12T13:57:37.000-03:00
diff --git a/Source/Documentation/Manual/images/options-simulation.png b/Source/Documentation/Manual/images/options-simulation.png
diff --git a/Source/Documentation/Manual/options.rst b/Source/Documentation/Manual/options.rst
@@ -136,10 +136,10 @@ These windows use the abbreviations *t-us* for short tons (2000 lb),
 Note: The units displayed by the :ref:`F4 Track Monitor <driving-track-monitor>` (e.g. velocity and
 distance) are always based on data read from the route files.
 
-Disable TCS scripts
+Enable TCS scripts
 -------------------
 
-This option disables the train control system scripts for locomotives where
+This option enables the train control system scripts for locomotives where
 these have been implemented.
 
 .. _options-web-server-port:
@@ -385,10 +385,12 @@ displayed as a message. This option is described in detail
 OR does not display the damage.
 
 
-Steam locomotive hot start
---------------------------
+At game start, Steam - pre-heat boiler
+--------------------------------------
 
 With this option selected, the temperature and pressure of steam in the boiler is ready to pull the train.
+Uncheck this option for a more detailed behaviour in which the player has to raise the boiler pressure.
+
 If not, the boiler pressure will be at 2/3 of maximum, which is only adequate for light work.
 If your schedule gives you time to raise the pressure close to maximum, then 
 switch from AI Firing to Manual Firing (Ctrl+F) and increase the Blower (N) to 100% to raise a draught. 
@@ -397,6 +399,16 @@ Full pressure may be reached in 5 minutes or so.
 
 The default setting is checked.
 
+
+At game start, Diesel - run engines
+-----------------------------------
+
+When this option is checked, stationary diesel locos start the simulation with their engines running.
+Uncheck this option for a more detailed behaviour in which the player has to start the loco's engine.
+
+The default setting is checked.
+
+
 .. _options-forced-red:
 
 Forced red at station stops
@@ -466,14 +478,6 @@ With vacuum braking, it is sometimes necessary to operate two different controls
 With "Simple control and physics" checked, the player is able to operate the brakes just with the brake valve 
 and doesn't need to consider the steam ejector separately.
 
-Diesel engines stopped at simulation start
-------------------------------------------
-
-When this option is unchecked, stationary diesel locos start the simulation with their engines running.
-Check this option for a more detailed behaviour in which the player has to start the loco's engine.
-
-The default setting is unchecked.
-
 
 .. _options-keyboard:
 
diff --git a/Source/Menu/Options.Designer.cs b/Source/Menu/Options.Designer.cs
diff --git a/Source/Menu/Options.cs b/Source/Menu/Options.cs
@@ -142,14 +142,14 @@ public OptionsForm(UserSettings settings, UpdateManager updateManager, bool init
             checkAlerterExternal.Enabled = Settings.Alerter;
             checkAlerterExternal.Checked = Settings.Alerter && !Settings.AlerterDisableExternal;
             checkOverspeedMonitor.Checked = Settings.SpeedControl;
-            checkControlConfirmations.Checked = !Settings.SuppressConfirmations;
+            checkControlConfirmations.Checked = !Settings.SuppressConfirmations; // Inverted as "Show confirmations" is better UI than "Suppress confirmations"
             checkRetainers.Checked = Settings.RetainersOnAllCars;
             checkGraduatedRelease.Checked = Settings.GraduatedRelease;
             numericBrakePipeChargingRate.Value = Settings.BrakePipeChargingRate;
             comboLanguage.Text = Settings.Language;
             comboPressureUnit.Text = Settings.PressureUnit;
             comboOtherUnits.Text = settings.Units;
-            checkDisableTCSScripts.Checked = Settings.DisableTCSScripts;
+            checkEnableTCSScripts.Checked = !Settings.DisableTCSScripts;    // Inverted as "Enable scripts" is better UI than "Disable scripts"
             numericWebServerPort.Value = Settings.WebServerPort;
 
             // Audio tab
@@ -187,10 +187,10 @@ public OptionsForm(UserSettings settings, UpdateManager updateManager, bool init
             numericAdhesionMovingAverageFilterSize.Value = Settings.AdhesionMovingAverageFilterSize;
             checkBreakCouplers.Checked = Settings.BreakCouplers;
             checkCurveSpeedDependent.Checked = Settings.CurveSpeedDependent;
-            checkHotStart.Checked = Settings.HotStart;
+            checkBoilerPreheated.Checked = Settings.HotStart;
             checkForcedRedAtStationStops.Checked = !Settings.NoForcedRedAtStationStops;
             checkDoorsAITrains.Checked = Settings.OpenDoorsInAITrains;
-            checkBoxNoDieselEngineStart.Checked = Settings.NoDieselEngineStart;
+            checkDieselEnginesStarted.Checked = !Settings.NoDieselEngineStart; // Inverted as "EngineStart" is better UI than "NoEngineStart"
 
             // Keyboard tab
             InitializeKeyboardSettings();
@@ -321,7 +321,7 @@ orderby folder.Key
             checkAdhesionPropToWeather.Checked = Settings.AdhesionProportionalToWeather;
             trackAdhesionFactorChange.Value = Settings.AdhesionFactorChange;
             trackAdhesionFactor_ValueChanged(null, null);
-            checkShapeWarnings.Checked = !Settings.SuppressShapeWarnings;
+            checkShapeWarnings.Checked = !Settings.SuppressShapeWarnings;   // Inverted as "Show warnings" is better UI than "Suppress warnings"
             precipitationBoxHeight.Value = Settings.PrecipitationBoxHeight;
             precipitationBoxWidth.Value = Settings.PrecipitationBoxWidth;
             precipitationBoxLength.Value = Settings.PrecipitationBoxLength;
@@ -429,7 +429,7 @@ void buttonOK_Click(object sender, EventArgs e)
             Settings.Language = comboLanguage.SelectedValue.ToString();
             Settings.PressureUnit = comboPressureUnit.SelectedValue.ToString();
             Settings.Units = comboOtherUnits.SelectedValue.ToString();
-            Settings.DisableTCSScripts = checkDisableTCSScripts.Checked;
+            Settings.DisableTCSScripts = !checkEnableTCSScripts.Checked; // Inverted as "Enable scripts" is better UI than "Disable scripts"
             Settings.WebServerPort = (int)numericWebServerPort.Value;
 
             // Audio tab
@@ -461,10 +461,10 @@ void buttonOK_Click(object sender, EventArgs e)
             Settings.AdhesionMovingAverageFilterSize = (int)numericAdhesionMovingAverageFilterSize.Value;
             Settings.BreakCouplers = checkBreakCouplers.Checked;
             Settings.CurveSpeedDependent = checkCurveSpeedDependent.Checked;
-            Settings.HotStart = checkHotStart.Checked;
+            Settings.HotStart = checkBoilerPreheated.Checked;
             Settings.NoForcedRedAtStationStops = !checkForcedRedAtStationStops.Checked;
             Settings.OpenDoorsInAITrains = checkDoorsAITrains.Checked;
-            Settings.NoDieselEngineStart = checkBoxNoDieselEngineStart.Checked;
+            Settings.NoDieselEngineStart = !checkDieselEnginesStarted.Checked; // Inverted as "EngineStart" is better UI than "NoEngineStart"
 
             // Keyboard tab
             // These are edited live.
@@ -818,7 +818,7 @@ private void InitializeHelpIcons()
                 (pbLanguage, new Control[] { labelLanguage, comboLanguage }),
                 (pbPressureUnit, new Control[] { labelPressureUnit, comboPressureUnit }),
                 (pbOtherUnits, new Control[] { labelOtherUnits, comboOtherUnits }),
-                (pbDisableTcsScripts, new[] { checkDisableTCSScripts }),
+                (pbEnableTcsScripts, new[] { checkEnableTCSScripts }),
                 (pbOverspeedMonitor, new[] { checkOverspeedMonitor }),
             };
             foreach ((PictureBox pb, Control[] controls) in helpIconControls)
@@ -873,7 +873,7 @@ private void HelpIcon_Click(object sender, EventArgs _)
                     baseUrl + "/options.html#other-units"
                 },
                 {
-                    pbDisableTcsScripts,
+                    pbEnableTcsScripts,
                     baseUrl + "/options.html#disable-tcs-scripts"
                 },
                 {
diff --git a/Source/ORTS.Common/SmoothedData.cs b/Source/ORTS.Common/SmoothedData.cs
@@ -24,18 +24,24 @@ namespace ORTS.Common
 {
     public class SmoothedData
     {
-        public readonly float SmoothPeriodS = 3;
+        const float DefaultSmoothPeriodS = 3;
+
+        public readonly float SmoothPeriodS;
+
+        protected float rate = 0;
         protected float value = float.NaN;
         protected float smoothedValue = float.NaN;
 
         public SmoothedData()
+            : this(DefaultSmoothPeriodS)
         {
         }
 
         public SmoothedData(float smoothPeriodS)
-            : this()
         {
             SmoothPeriodS = smoothPeriodS;
+            // Convert the input assuming 60 FPS (arbitary)
+            rate = (float)(-60 * Math.Log(1 - 1 / (60 * SmoothPeriodS)));
         }
 
         public void Update(float periodS, float newValue)
@@ -53,13 +59,12 @@ public void Update(float periodS, float newValue)
 
         protected void SmoothValue(ref float smoothedValue, float periodS, float newValue)
         {
-            var rate = SmoothPeriodS / periodS;
-            if (float.IsNaN(smoothedValue) || float.IsInfinity(smoothedValue))
-                smoothedValue = newValue;
-            else if (rate < 1)
+            // This formula and the calculation of `rate` are FPS-independent; see https://www.gamedeveloper.com/programming/improved-lerp-smoothing- for more details
+            var ratio = (float)Math.Exp(-rate * periodS);
+            if (float.IsNaN(smoothedValue) || float.IsInfinity(smoothedValue) || ratio < 0.5)
                 smoothedValue = newValue;
             else
-                smoothedValue = (smoothedValue * (rate - 1) + newValue) / rate;
+                smoothedValue = smoothedValue * ratio + newValue * (1 - ratio);
         }
 
         public void ForceSmoothValue(float forcedValue)
diff --git a/Source/Orts.Simulation/MultiPlayer/ClientComm.cs b/Source/Orts.Simulation/MultiPlayer/ClientComm.cs
@@ -88,7 +88,6 @@ public void Receive(object client)
 			while (true)
 			{
 				bytesRead = 0;
-				//System.Threading.Thread.Sleep(Program.Random.Next(50, 200));
 				try
 				{
 					//blocks until a client sends a message
diff --git a/Source/Orts.Simulation/MultiPlayer/OnlinePlayer.cs b/Source/Orts.Simulation/MultiPlayer/OnlinePlayer.cs
@@ -106,7 +106,6 @@ public void Receive(object client)
 
 			while (true)
 			{
-				//System.Threading.Thread.Sleep(Program.Random.Next(50, 200));
 
 				bytesRead = 0;
 
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs
@@ -173,8 +173,8 @@ public enum SoundState
         public float MaxTotalCombinedWaterVolumeUKG;
         public MSTSNotchController WaterController = new MSTSNotchController(0, 1, 0.01f);
         public float CombinedTenderWaterVolumeUKG          // Decreased by running injectors and increased by refilling
-        {
-            get { return WaterController.CurrentValue* MaxTotalCombinedWaterVolumeUKG; }
+        {          
+            get { return WaterController.CurrentValue * MaxTotalCombinedWaterVolumeUKG; }
             set { WaterController.CurrentValue = value / MaxTotalCombinedWaterVolumeUKG; }
         }
 
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs
@@ -1400,8 +1400,8 @@ public override void Initialize()
 
             if (RestoredCombinedTenderWaterVolumeUKG > 1.0)// Check to see if this is a restored game -(assumed so if Restored >0), then set water controller values based upon saved values
             {
-                CombinedTenderWaterVolumeUKG = RestoredCombinedTenderWaterVolumeUKG;
                 MaxTotalCombinedWaterVolumeUKG = RestoredMaxTotalCombinedWaterVolumeUKG;
+                CombinedTenderWaterVolumeUKG = RestoredCombinedTenderWaterVolumeUKG;
             }
 
             InitializeTenderWithWater();
diff --git a/Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs b/Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs
@@ -2087,6 +2087,9 @@ public int GetDrawIndex()
                 case CABViewControlTypes.OVERSPEED:
                 case CABViewControlTypes.PENALTY_APP:
                 case CABViewControlTypes.EMERGENCY_BRAKE:
+                case CABViewControlTypes.ORTS_BAILOFF:
+                case CABViewControlTypes.ORTS_QUICKRELEASE:
+                case CABViewControlTypes.ORTS_OVERCHARGE:
                 case CABViewControlTypes.DOORS_DISPLAY:
                 case CABViewControlTypes.CYL_COCKS:
                 case CABViewControlTypes.ORTS_BLOWDOWN_VALVE:
diff --git a/Source/RunActivity/Viewer3D/Weather.cs b/Source/RunActivity/Viewer3D/Weather.cs
@@ -107,7 +107,7 @@ public WeatherControl(Viewer viewer)
                     UpdateSoundSources();
                     UpdateVolume();
                     // We have a pause in weather change, depending from randomization level
-                    dynamicWeather.stableWeatherTimer = ( 4.0f - Viewer.Settings.ActWeatherRandomizationLevel) * 600 + Simulator.Random.Next(300) - 150;
+                    dynamicWeather.stableWeatherTimer = ( 4.0f - Viewer.Settings.ActWeatherRandomizationLevel) * 600 + Viewer.Random.Next(300) - 150;
                     weatherChangeOn = true;
                 }
 
@@ -262,14 +262,14 @@ private bool RandomizeInitialWeather()
             CheckDesertZone();
             if (DesertZone) return false;
             // First define overcast
-            var randValue = Simulator.Random.Next(170);
+            var randValue = Viewer.Random.Next(170);
             var intermValue = randValue >= 50 ? (float)(randValue - 50f) : (float)randValue;
             Weather.OvercastFactor = intermValue >= 20 ? (float)(intermValue - 20f)/100f: (float)intermValue/100f; // give more probability to less overcast
             Viewer.Simulator.WeatherType = Orts.Formats.Msts.WeatherType.Clear;
             // Then check if we are in precipitation zone
             if (Weather.OvercastFactor > 0.5)
             {
-                randValue = Simulator.Random.Next(75);
+                randValue = Viewer.Random.Next(75);
                 if (randValue > 40)
                 {
                     Weather.PricipitationIntensityPPSPM2 = (float)(randValue - 40f) / 1000f;
@@ -288,7 +288,7 @@ private bool RandomizeInitialWeather()
             }
             else Weather.PricipitationIntensityPPSPM2 = 0;
             // and now define visibility
-            randValue = Simulator.Random.Next(2000);
+            randValue = Viewer.Random.Next(2000);
             if (Weather.PricipitationIntensityPPSPM2 > 0 || Weather.OvercastFactor > 0.7f )
             // use first digit to define power of ten and the other three to define the multiplying number
                 Weather.FogDistance =  Math.Max ( 100, (float)Math.Pow(10 , ((int)(randValue / 1000) + 2)) * (float)((randValue % 1000 + 1) / 100f));
@@ -772,9 +772,9 @@ public void WeatherChange_NextRandomization(ElapsedTime elapsedTime, WeatherCont
             {
                 // define how much time transition will last
                 var weatherChangeTimer = (4 - weatherControl.Viewer.Settings.ActWeatherRandomizationLevel) * 600 +
-                    Simulator.Random.Next((4 - weatherControl.Viewer.Settings.ActWeatherRandomizationLevel) * 600);
+                    Viewer.Random.Next((4 - weatherControl.Viewer.Settings.ActWeatherRandomizationLevel) * 600);
                 // begin with overcast
-                var randValue = Simulator.Random.Next(170);
+                var randValue = Viewer.Random.Next(170);
                 var intermValue = randValue >= 50 ? (float)(randValue - 50f) : (float)randValue;
                 ORTSOvercast = intermValue >= 20 ? (float)(intermValue - 20f) / 100f : (float)intermValue / 100f; // give more probability to less overcast
                 ORTSOvercastTransitionTimeS = weatherChangeTimer;
@@ -783,7 +783,7 @@ public void WeatherChange_NextRandomization(ElapsedTime elapsedTime, WeatherCont
                 // Then check if we are in precipitation zone
                 if (ORTSOvercast > 0.5)
                 {
-                    randValue = Simulator.Random.Next(75);
+                    randValue = Viewer.Random.Next(75);
                     if (randValue > 40)
                     {
                         ORTSPrecipitationIntensity = (float)(randValue - 40f) / 1000f;
@@ -821,7 +821,7 @@ public void WeatherChange_NextRandomization(ElapsedTime elapsedTime, WeatherCont
                 }
 
                 // and now define visibility
-                randValue = Simulator.Random.Next(2000);
+                randValue = Viewer.Random.Next(2000);
                 if (ORTSPrecipitationIntensity > 0 || ORTSOvercast > 0.7f)
                     // use first digit to define power of ten and the other three to define the multiplying number
                     ORTSFog = Math.Max(100, (float)Math.Pow(10, ((int)(randValue / 1000) + 2)) * (float)((randValue % 1000 + 1) / 100f));
diff --git a/Source/Tests/Orts.Common/SmoothedData.cs b/Source/Tests/Orts.Common/SmoothedData.cs
@@ -0,0 +1,47 @@
+// COPYRIGHT 2022 by the Open Rails project.
+// 
+// This file is part of Open Rails.
+// 
+// Open Rails is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// Open Rails is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+// 
+// 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.Linq;
+using Xunit;
+
+namespace Tests.Orts.Common
+{
+    public static class SmoothedData
+    {
+        [Theory]
+        // FPS-like tests
+        [InlineData(5, 3, 0.353)]
+        [InlineData(10, 3, 0.353)]
+        [InlineData(30, 3, 0.353)]
+        [InlineData(60, 3, 0.353)]
+        [InlineData(120, 3, 0.353)]
+        // Physics-like tests
+        [InlineData(60, 1, 0.000)] // Exhaust particles
+        [InlineData(60, 2, 0.066)] // Smoke colour
+        [InlineData(60, 45, 8.007)] // Field rate
+        [InlineData(60, 150, 9.355)] // Burn rate
+        [InlineData(60, 240, 9.592)] // Boiler heat
+        public static void SmoothedFPS(int fps, float smoothPeriodS, float expected)
+        {
+            var period = (float)(1d / fps);
+            var smoothed = new ORTS.Common.SmoothedData(smoothPeriodS);
+            smoothed.Update(0, 10);
+            foreach (var i in Enumerable.Range(0, 10 * fps)) smoothed.Update(period, 0);
+            Assert.Equal(expected, smoothed.SmoothedValue, 3);
+        }
+    }
+}
diff --git a/Source/Tests/Tests.csproj b/Source/Tests/Tests.csproj
@@ -65,6 +65,7 @@
     <Compile Include="DynamicPrecisionEqualityComparer.cs" />
     <Compile Include="Orts.Parsers.Msts\StfReader.cs" />
     <Compile Include="Orts.Common\Conversions.cs" />
+    <Compile Include="Orts.Common\SmoothedData.cs" />
     <Compile Include="Orts.Parsers.OR\TimetableReaderTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="TestFile.cs" />

Original file line number	Diff line number	Diff line change
`@@ -24,18 +24,24 @@ namespace ORTS.Common`
`24`	`24`	`{`
`25`	`25`	`public class SmoothedData`
`26`	`26`	`{`
`27`		`- public readonly float SmoothPeriodS = 3;`
	`27`	`+ const float DefaultSmoothPeriodS = 3;`
	`28`	`+`
	`29`	`+ public readonly float SmoothPeriodS;`
	`30`	`+`
	`31`	`+ protected float rate = 0;`
`28`	`32`	`protected float value = float.NaN;`
`29`	`33`	`protected float smoothedValue = float.NaN;`
`30`	`34`
`31`	`35`	`public SmoothedData()`
	`36`	`+ : this(DefaultSmoothPeriodS)`
`32`	`37`	`{`
`33`	`38`	`}`
`34`	`39`
`35`	`40`	`public SmoothedData(float smoothPeriodS)`
`36`		`- : this()`
`37`	`41`	`{`
`38`	`42`	`SmoothPeriodS = smoothPeriodS;`
	`43`	`+ // Convert the input assuming 60 FPS (arbitary)`
	`44`	`+ rate = (float)(-60 * Math.Log(1 - 1 / (60 * SmoothPeriodS)));`
`39`	`45`	`}`
`40`	`46`
`41`	`47`	`public void Update(float periodS, float newValue)`
`@@ -53,13 +59,12 @@ public void Update(float periodS, float newValue)`
`53`	`59`
`54`	`60`	`protected void SmoothValue(ref float smoothedValue, float periodS, float newValue)`
`55`	`61`	`{`
`56`		`- var rate = SmoothPeriodS / periodS;`
`57`		`- if (float.IsNaN(smoothedValue) \|\| float.IsInfinity(smoothedValue))`
`58`		`- smoothedValue = newValue;`
`59`		`- else if (rate < 1)`
	`62`	+ // This formula and the calculation of `rate` are FPS-independent; see https://www.gamedeveloper.com/programming/improved-lerp-smoothing- for more details
	`63`	`+ var ratio = (float)Math.Exp(-rate * periodS);`
	`64`	`+ if (float.IsNaN(smoothedValue) \|\| float.IsInfinity(smoothedValue) \|\| ratio < 0.5)`
`60`	`65`	`smoothedValue = newValue;`
`61`	`66`	`else`
`62`		`- smoothedValue = (smoothedValue * (rate - 1) + newValue) / rate;`
	`67`	`+ smoothedValue = smoothedValue * ratio + newValue * (1 - ratio);`
`63`	`68`	`}`
`64`	`69`
`65`	`70`	`public void ForceSmoothValue(float forcedValue)`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,6 @@ public void Receive(object client)`
`88`	`88`	`while (true)`
`89`	`89`	`{`
`90`	`90`	`bytesRead = 0;`
`91`		`- //System.Threading.Thread.Sleep(Program.Random.Next(50, 200));`
`92`	`91`	`try`
`93`	`92`	`{`
`94`	`93`	`//blocks until a client sends a message`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,6 @@ public void Receive(object client)`
`106`	`106`
`107`	`107`	`while (true)`
`108`	`108`	`{`
`109`		`- //System.Threading.Thread.Sleep(Program.Random.Next(50, 200));`
`110`	`109`
`111`	`110`	`bytesRead = 0;`
`112`	`111`
Original file line number	Diff line number	Diff line change
`@@ -1400,8 +1400,8 @@ public override void Initialize()`
`1400`	`1400`
`1401`	`1401`	`if (RestoredCombinedTenderWaterVolumeUKG > 1.0)// Check to see if this is a restored game -(assumed so if Restored >0), then set water controller values based upon saved values`
`1402`	`1402`	`{`
`1403`		`- CombinedTenderWaterVolumeUKG = RestoredCombinedTenderWaterVolumeUKG;`
`1404`	`1403`	`MaxTotalCombinedWaterVolumeUKG = RestoredMaxTotalCombinedWaterVolumeUKG;`
	`1404`	`+ CombinedTenderWaterVolumeUKG = RestoredCombinedTenderWaterVolumeUKG;`
`1405`	`1405`	`}`
`1406`	`1406`
`1407`	`1407`	`InitializeTenderWithWater();`