Automatic merge of T1.5.1-1777-ga440b33f8 and 16 pull requests

- Pull request #570 at 362e4e7: glTF 2.0 support with PBR lighting
- Pull request #1062 at bbc0013: Train Forces popup Window.
- Pull request #1064 at cb510d6: Add Train Info tab to Help window (F1)
- Pull request #1066 at 62c89c1: Log derailment, using TraceInformation.
- Pull request #1082 at ca0d8e5: Allow variable water level in glass gauge
- Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH
- Pull request #1057 at 84592f7: Switchable brake system
- Pull request #1069 at 99fc9ac: Mouse wheel control only with Alt – Followup for #1051
- Pull request #1070 at f818e40: Fix a NullReferenceException in TCS scripts
- Pull request #1074 at e9a66c1: Gradient - commit 2024-16-12
- Pull request #1076 at 3bbd537: Allow depart early
- Pull request #1077 at 7e73abd: Fix SME brakes not working
- Pull request #1078 at 9ab642e: Default PowerSupply script for steam locomotives
- Pull request #1079 at 5e37059: Adds Polish transations
- Pull request #1083 at 7e6fb60: Menu contents route name clash
- Pull request #1081 at 689494b: Brake cuts power unification

Author: openrails-bot

Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs

@@ -261,6 +261,9 @@ public class MSTSSteamLocomotive : MSTSLocomotive
         float MSTSBoilerLengthM;
         float ORBoilerLengthM;
         float BoilerLengthM;
+        float BoilerDiameterM;
+        float BoilerCrownCoverageHeightM;
+        float BoilerCrownHeightM;
         public float GradientBoilerLevelPercent;
         public int MSTSNumCylinders = 2;       // Number of Cylinders
         public float MSTSCylinderStrokeM;      // High pressure cylinders
@@ -955,6 +958,9 @@ public override void Parse(string lowercasetoken, STFReader stf)
                 case "engine(boilervolume": BoilerVolumeFT3 = stf.ReadFloatBlock(STFReader.UNITS.VolumeDefaultFT3, null); break;
                 case "engine(boilerlength": MSTSBoilerLengthM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); break;
                 case "engine(ortsboilerlength": ORBoilerLengthM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); break;
+                case "engine(ortsboilerdiameter": BoilerDiameterM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); break;
+                case "engine(ortsboilercrownheight": BoilerCrownHeightM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); break;
+                case "engine(ortsboilercrowncoverageheight": BoilerCrownCoverageHeightM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); break;
                 case "engine(steamgaugeglassheight": MSTSSteamGaugeGlassHeightM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); break;
                 case "engine(ortswatergaugeglassheight": ORSteamGaugeGlassHeightM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); break;
                 case "engine(maxboilerpressure": MaxBoilerPressurePSI = stf.ReadFloatBlock(STFReader.UNITS.PressureDefaultPSI, null); break;
@@ -1105,6 +1111,8 @@ public override void Copy(MSTSWagon copy)
             BoilerVolumeFT3 = locoCopy.BoilerVolumeFT3;
             MSTSBoilerLengthM = locoCopy.MSTSBoilerLengthM;
             ORBoilerLengthM = locoCopy.ORBoilerLengthM;
+            BoilerCrownHeightM = locoCopy.BoilerCrownHeightM;
+            BoilerCrownCoverageHeightM = locoCopy.BoilerCrownCoverageHeightM;
             MSTSSteamGaugeGlassHeightM = locoCopy.MSTSSteamGaugeGlassHeightM;
             ORSteamGaugeGlassHeightM = locoCopy.ORSteamGaugeGlassHeightM;
             MaxBoilerPressurePSI = locoCopy.MaxBoilerPressurePSI;
@@ -1520,13 +1528,24 @@ public override void Initialize()
             }
             */
 
+            if (ORBoilerLengthM > 0 && ORSteamGaugeGlassHeightM > 0 && BoilerDiameterM == 0)
+            {
+                BoilerDiameterM = 2.0f;
 
-            if (WaterGlassLengthM > 0 && BoilerLengthM > 0 )
+                if (Simulator.Settings.VerboseConfigurationMessages)
+                {
+                    Trace.TraceInformation("Boiler diameter set to default = {0}", FormatStrings.FormatDistance(BoilerCrownCoverageHeightM, IsMetric));
+                }
+            }
+
+            if (WaterGlassLengthM > 0 && BoilerLengthM > 0 && ORBoilerLengthM > 0 && BoilerCrownHeightM > 0 && BoilerCrownCoverageHeightM >0)
             {
                 WaterGlassLevelGradientEnabled = true;
             }
 
-    //        Trace.TraceInformation("Boiler Water Level - MSTSLength {0} ORLength {1} MSTSGlass {2} OR Glass {3} Enabled {4}, WaterGlass {5} BoilerLength {6}", MSTSBoilerLengthM, ORBoilerLengthM, MSTSSteamGaugeGlassHeightM, ORSteamGaugeGlassHeightM, WaterGlassLevelGradientEnabled, WaterGlassLengthM, BoilerLengthM);
+            Trace.TraceInformation("Boiler - CrownHeight {0} CrownCoverage {1}", BoilerCrownHeightM, BoilerCrownCoverageHeightM);
+
+    //       Trace.TraceInformation("Boiler Water Level - MSTSLength {0} ORLength {1} MSTSGlass {2} OR Glass {3} Enabled {4}, WaterGlass {5} BoilerLength {6}", MSTSBoilerLengthM, ORBoilerLengthM, MSTSSteamGaugeGlassHeightM, ORSteamGaugeGlassHeightM, WaterGlassLevelGradientEnabled, WaterGlassLengthM, BoilerLengthM);
 
             float BoilerVolumeCheck = Me2.ToFt2(EvaporationAreaM2) / BoilerVolumeFT3;    //Calculate the Boiler Volume Check value.
             if (BoilerVolumeCheck > 15) // If boiler volume is not in ENG file or less then a viable figure (ie high ratio figure), then set to a default value
@@ -7098,6 +7117,56 @@ private void UpdateAuxiliaries(float elapsedClockSeconds, float absSpeedMpS)
 
         private void UpdateWaterGauge()
         {
+            // Calculate water glass level when on gradient
+            if (WaterGlassLevelGradientEnabled)
+            {
+                var boilerangleRad = Math.Atan(CurrentElevationPercent / 100);
+                var waterVariationLevelM = (float)Math.Sin(boilerangleRad) * BoilerLengthM / 2.0f;
+
+                float glassLevelGradientM = 0;
+
+                // Downslope - CurrentElevationPercent = +ve, level variation will be -ve 
+                // Uphill  - CurrentElevationPercent = -ve, level variation will be +ve
+                // gradient variation due to slope needs to be reversed
+
+                    glassLevelGradientM = waterVariationLevelM * -1.0f;
+
+                // Assume that reference glass height is 50% of glass 
+                var maxWaterVariationIN = Me.ToIn(WaterGlassLengthM) / 2.0f;
+
+                float glasslevelfraction = 0;
+                float glasslevelM = 0;
+
+                // Calculate water level on level gradient
+                var referenceLevelFraction = (BoilerCrownCoverageHeightM + BoilerCrownHeightM + BoilerDiameterM / 2.0f)/BoilerDiameterM;
+
+                // Convert reference point to reading on glass
+                if (WaterFraction > referenceLevelFraction)
+                {
+                    glasslevelfraction = WaterFraction - referenceLevelFraction;
+
+                }
+                else if (WaterFraction < referenceLevelFraction)
+                {
+                    glasslevelfraction = -1.0f  * referenceLevelFraction - WaterFraction;
+                }
+
+                glasslevelM = glasslevelfraction * BoilerDiameterM;
+
+
+                var totalglassLevelM = glasslevelM + glassLevelGradientM;
+
+                GradientBoilerLevelPercent = totalglassLevelM * 100;
+
+                //             Trace.TraceInformation("Gradient - Current {0} BoilAng {1} GlassIN {2} Glass% {3}", CurrentElevationPercent, boilerangleRad, glasslevelIN,  GradientBoilerLevelPercent);
+
+          //      Trace.TraceInformation("Boiler - refLevel {0} GlassLevel {1} GlassLevelM {2} GradientLevel {3} TotalLevel {4} % {5}", referenceLevelFraction, glasslevelfraction, glasslevelM, glassLevelGradientM, totalglassLevelM, GradientBoilerLevelPercent);
+
+            }
+
+
+
+
             WaterGlassLevelIN = ((WaterFraction - WaterGlassMinLevel) / (WaterGlassMaxLevel - WaterGlassMinLevel)) * WaterGlassLengthIN;
             WaterGlassLevelIN = MathHelper.Clamp(WaterGlassLevelIN, 0, WaterGlassLengthIN);
 
@@ -7124,33 +7193,7 @@ private void UpdateWaterGauge()
                 BoilerIsPriming = false;
             }
 
-            // Calculate water glass level when on gradient
-            if (WaterGlassLevelGradientEnabled)
-            {
-                var boilerangleRad = Math.Atan(CurrentElevationPercent / 100);
-                var waterVariationLevelM = (float)Math.Sin(boilerangleRad) * BoilerLengthM / 2.0f;
-
-                // Assume that reference glass height is 50% of glass 
-                var maxWaterVariationIN = Me.ToIn(WaterGlassLengthM) / 2.0f;
 
-                float glasslevelIN = 0;
-                float glassLevelFraction = 0;
-
-                if (CurrentElevationPercent > 0)  // Downslope - -ve water slope
-                {
-                    glasslevelIN -= Me.ToIn(waterVariationLevelM) * -1.0f;                    
-                }
-                else   // up slope - +ve water level
-                {
-                    glasslevelIN += Me.ToIn(waterVariationLevelM) * -1.0f;
-                }
-
-                glassLevelFraction = glasslevelIN / maxWaterVariationIN;
-
-                GradientBoilerLevelPercent = glassLevelFraction * 100;
-
-//             Trace.TraceInformation("Gradient - Current {0} BoilAng {1} GlassIN {2} Glass% {3}", CurrentElevationPercent, boilerangleRad, glasslevelIN,  GradientBoilerLevelPercent);
-            }
 
 
         }