Automatic merge of T1.5.1-1741-gf80cfb5d1 and 20 pull requests

- Pull request #570 at f11a428: glTF 2.0 support with PBR lighting
- Pull request #1030 at d3ae4a2: Refactor settings, in prep for settings exporter
- Pull request #1052 at 3b5cb90: Content Manager: Add axle count, and lowest derail force
- 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 b96420f: Allow variable water level in glass gauge
- Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH
- Pull request #1049 at 6a0c471: Re-organise document storage and access
- Pull request #1057 at d4dcf7e: 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 #1071 at 722dd3f: Change cover image for v1.6
- Pull request #1074 at e9a66c1: Gradient - commit 2024-16-12
- Pull request #1076 at d1ff8fd: 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 #1080 at a637cb8: arranges Options > System tab for longer texts
- Pull request #1081 at 689494b: Brake cuts power unification

Author: openrails-bot

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

@@ -258,6 +258,10 @@ public class MSTSSteamLocomotive : MSTSLocomotive
         // eng file configuration parameters
 
         float BoilerVolumeFT3;      // total space in boiler that can hold water and steam
+        float MSTSBoilerLengthM;
+        float ORBoilerLengthM;
+        float BoilerLengthM;
+        public float GradientBoilerLevelPercent;
         public int MSTSNumCylinders = 2;       // Number of Cylinders
         public float MSTSCylinderStrokeM;      // High pressure cylinders
         public float MSTSCylinderDiameterM;    // High pressure cylinders
@@ -455,7 +459,11 @@ public float TenderFuelMassKG              // Decreased by firing and increased
         float WaterGlassMinLevel = 0.73f;   // min height of water gauge as a fraction of boiler level
         float WaterGlassLengthIN = 8.0f;    // nominal length of water gauge
         float WaterGlassLevelIN;            // Water glass level in inches
+        float ORSteamGaugeGlassHeightM;
+        float MSTSSteamGaugeGlassHeightM;
+        float WaterGlassLengthM;
         float waterGlassPercent;            // Water glass level in percent
+        bool WaterGlassLevelGradientEnabled = false;
         float MEPFactor = 0.7f;             // Factor to determine the MEP
         float GrateAreaDesignFactor = 500.0f;   // Design factor for determining Grate Area
         float EvapAreaDesignFactor = 10.0f;     // Design factor for determining Evaporation Area
@@ -945,6 +953,10 @@ public override void Parse(string lowercasetoken, STFReader stf)
                 case "engine(lpcylinderdiameter": MSTSLPCylinderDiameterM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); break;
                 case "engine(ortscylinderportopening": CylinderPortOpeningFactor = stf.ReadFloatBlock(STFReader.UNITS.None, null); break;
                 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(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;
                 case "engine(ortsmaxsuperheattemperature": MaxSuperheatRefTempF = stf.ReadFloatBlock(STFReader.UNITS.Temperature, null); break;
                 case "engine(ortsmaxindicatedhorsepower":
@@ -1091,6 +1103,10 @@ public override void Copy(MSTSWagon copy)
             CylinderExhaustOpenFactor = locoCopy.CylinderExhaustOpenFactor;
             CylinderPortOpeningFactor = locoCopy.CylinderPortOpeningFactor;
             BoilerVolumeFT3 = locoCopy.BoilerVolumeFT3;
+            MSTSBoilerLengthM = locoCopy.MSTSBoilerLengthM;
+            ORBoilerLengthM = locoCopy.ORBoilerLengthM;
+            MSTSSteamGaugeGlassHeightM = locoCopy.MSTSSteamGaugeGlassHeightM;
+            ORSteamGaugeGlassHeightM = locoCopy.ORSteamGaugeGlassHeightM;
             MaxBoilerPressurePSI = locoCopy.MaxBoilerPressurePSI;
             SteamLocomotiveFeedWaterType = locoCopy.SteamLocomotiveFeedWaterType;
             MaxSuperheatRefTempF = locoCopy.MaxSuperheatRefTempF;
@@ -1461,6 +1477,57 @@ public override void Initialize()
             BoilerEvapRateLbspFt2 = MathHelper.Clamp(BoilerEvapRateLbspFt2, 7.5f, 30.0f); // Clamp BoilerEvap Rate to between 7.5 & 30 - some modern locomotives can go as high as 30, but majority are around 15.
             TheoreticalMaxSteamOutputLBpS = pS.FrompH(Me2.ToFt2(EvaporationAreaM2) * BoilerEvapRateLbspFt2); // set max boiler theoretical steam output
 
+            // Initialise Boiler parameters
+
+            // Boiler Length - always use OR entered value as first preference
+            BoilerLengthM = ORBoilerLengthM;
+
+            /*
+            // If OR value hasn't been set, then use MSTS value if present
+            if (BoilerLengthM == 0 && MSTSBoilerLengthM > 0) 
+            {
+                if (MSTSBoilerLengthM > 0.4f * CarLengthM && MSTSBoilerLengthM < CarLengthM)
+                {
+                    BoilerLengthM = MSTSBoilerLengthM;
+
+                    if (Simulator.Settings.VerboseConfigurationMessages)
+                    {
+                        Trace.TraceInformation("Boiler Length set as per MSTS default = {0}", FormatStrings.FormatDistance(BoilerLengthM, IsMetric));
+                    }
+                }
+            }
+            */
+
+            // Water Gauge Length - always use OR entered value as first preference
+            WaterGlassLengthM = ORSteamGaugeGlassHeightM;
+
+            /*
+            // If OR value hasn't been set, then use MSTS value if present
+            if (WaterGlassLengthM == 0 && MSTSSteamGaugeGlassHeightM > 0)
+            {
+                var defaultGlassLength = Me.FromIn(12);
+
+                if (MSTSSteamGaugeGlassHeightM < defaultGlassLength)
+                {
+                    WaterGlassLengthM = MSTSSteamGaugeGlassHeightM;
+                    WaterGlassLengthIN = Me.ToIn(WaterGlassLengthM);
+
+                    if (Simulator.Settings.VerboseConfigurationMessages)
+                    {
+                        Trace.TraceInformation("Water Glass Length set as per MSTS default = {0}", FormatStrings.FormatDistance(WaterGlassLengthM, IsMetric));
+                    }
+                }
+            }
+            */
+
+
+            if (WaterGlassLengthM > 0 && BoilerLengthM > 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);
+
             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
             {
@@ -7056,6 +7123,36 @@ private void UpdateWaterGauge()
                     Simulator.Confirmer.Message(ConfirmLevel.Information, Simulator.Catalog.GetString("Boiler no longer priming."));
                 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);
+            }
+
+
         }
 
         private void UpdateWaterInjection(float elapsedClockSeconds)
@@ -7828,7 +7925,15 @@ public override string GetStatus()
                     SteamGearRatio, SteamGearPosition == 0 ? Simulator.Catalog.GetParticularString("Gear", "N") : SteamGearPosition.ToString());
             status.AppendFormat("{0}{2} = {1}/{3}{2}\n", Simulator.Catalog.GetString("Steam usage"), FormatStrings.FormatMass(pS.TopH(Kg.FromLb(PreviousTotalSteamUsageLBpS)), MainPressureUnit != PressureUnit.PSI), steamusagesafety, FormatStrings.h);
             status.AppendFormat("{0}{2} = {1}{2}\n", Simulator.Catalog.GetString("Boiler pressure"), FormatStrings.FormatPressure(BoilerPressurePSI, PressureUnit.PSI, MainPressureUnit, true), boilerPressureSafety);
-            status.AppendFormat("{0}{2} = {1:F0}% {3}{2}\n", Simulator.Catalog.GetString("Boiler water glass"), 100 * waterGlassPercent, boilerWaterSafety, FiringIsManual ? Simulator.Catalog.GetString("(safe range)") : "");
+
+            if (WaterGlassLevelGradientEnabled)
+            {
+                status.AppendFormat("{0}{2} = {1:F0}% {3}{2}\n", Simulator.Catalog.GetString("Boiler water glass"), GradientBoilerLevelPercent, boilerWaterSafety, FiringIsManual ? Simulator.Catalog.GetString("(safe range)") : "");
+            }
+            else
+            {
+                status.AppendFormat("{0}{2} = {1:F0}% {3}{2}\n", Simulator.Catalog.GetString("Boiler water glass"), 100 * waterGlassPercent, boilerWaterSafety, FiringIsManual ? Simulator.Catalog.GetString("(safe range)") : "");
+            }
 
             if (FiringIsManual)
             {

Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs

@@ -739,7 +739,7 @@ public virtual void LoadFromWagFile(string wagFilePath)
                 setIfPositive(ref LoadFullMaxHandbrakeForceN, FreightAnimations.FullPhysicsStaticOne?.FullStaticMaxHandbrakeForceN);
                 setIfPositive(ref LoadFullCentreOfGravityM_Y, FreightAnimations.FullPhysicsStaticOne?.FullStaticCentreOfGravityM_Y);
                 setIfPositive(ref LoadFullRelayValveRatio, FreightAnimations.FullPhysicsStaticOne?.FullStaticRelayValveRatio);
-                setIfPositive(ref LoadFullInshotPSI, FreightAnimations.FullPhysicsStaticOne?.FullStaticInshotPSI);
+                setIfNonZero(ref LoadFullInshotPSI, FreightAnimations.FullPhysicsStaticOne?.FullStaticInshotPSI);
 
                 // Read (initialise) Continuous load ones if a continuous load
                 // Test each value to make sure that it has been defined in the WAG file, if not default to Root WAG file value