Automatic merge of T1.5.1-1204-g8bc1d82939 and 17 pull requests

- Pull request #799 at dfc715e: Consolidated wind simulation
- Pull request #839 at d00beb9: First phase of https://blueprints.launchpad.net/or/+spec/additional-cruise-control-parameters
- Pull request #885 at 8f473ce: feat: Add notifications to Menu
- Pull request #891 at 9a1d6b2: Auto save
- Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH
- Pull request #952 at 8347095: Investigation - Pulsing graphics
- Pull request #953 at a519452: Fix Lights Crash on Corrupt Shapes
- Pull request #954 at c8a37a7: Multiple Track Profiles & Superelevation Improvements
- Pull request #962 at 46d0472: Fix pantographs on unpowered cars
- Pull request #972 at e90a2aa: On Map window color changed switch or signal is not changed
- Pull request #980 at a7406de: Downloading route content (Github, zip) second part 
- Pull request #981 at 10d297f: Multiple type trainset lightglows
- Pull request #982 at efcf19c: WEB based Switch Panel enhancement: Alerter
- Pull request #983 at 202316e: WEB based Switch Panel bug: DPU window
- Pull request #984 at 0f8122e: Player train switching for timetable mode
- Pull request #900 at c27f32d: DMI updates
- Pull request #876 at f92de76: docs: add source for documents previously on website to source Documentation folder

Author: openrails-bot

Source/Documentation/Manual/features-route.rst

@@ -881,30 +881,30 @@ file and add some (or all) of the following parameters inside the ``ORTSSuperEle
 
 - ``MaxFreightUnderbalance`` -- The maximum amount (using units of length) of cant deficiency/underbalance
   that should be allowed for trains travelling at the freight speed limit. Larger allowed underbalance
-  results in less extreme superelevation. (Default 5 cm ~ 2 inches.)
+  results in less extreme superelevation. (Default 100 mm for metric routes, 2 in for imperial routes.)
 - ``MaxPassengerUnderbalance`` -- The maximum amount (using units of length) of cant deficiency/underbalance
-  that should be allowed for trains travelling at the passenger speed limit. (Default 7.5 cm ~ 3 inches.)
+  that should be allowed for trains travelling at the passenger speed limit. (Default 150 mm / 3 in.)
   For comfort reasons, the underbalance values should be equal to or less than the
   ``ORTSUnbalancedSuperElevation`` value used by the rolling stock on the route. If the superelevation
   required to achieve the max passenger underbalance is different from that required for freight, the
   curve will use whichever superelevation is larger (the actual amount of underbalance may be lower).
 - ``MinimumCant`` -- If a curve needs superelevation, the amount of superelevation will be no lower than
-  this value (given in units of length). (Default 1.25 cm ~ 0.5 inches.)
+  this value (given in units of length). (Default 10 mm / 0.5 in.)
 - ``MaximumCant`` -- Sets the maximum amount of superelevation (units of length) that any curve is allowed
   to have, regardless of other factors. Usually curves should be designed to avoid reaching this limit, as
   exceeding the limit could result in excessive curve force or even trains toppling over at low speeds.
-  (Default is determined by the superelevation setting in the options menu. Level 0 = 7 cm, level 10 = 17 cm.)
+  (Default 180 mm / 6 in.)
 - ``Precision`` -- Determines the accuracy (in length) to which the superelevation is maintained. If
   the superelevation required by a curve is not a nice number, it will be rounded up to the nearest
-  multiple of ``Precision``. (Default 0.5 cm ~ 0.2 inches.)
+  multiple of ``Precision``. (Default 5 mm / 0.25 in.)
 - ``MaxRunOffSlope`` -- Sets a limit on the amount of change in superelevation per unit length along a curve
   (quantity is unitless). This allows for smooth transition between flat and superelevated track at low speeds.
   (Default 0.003.)
 - ``MaxRunOffSpeed`` -- Sets a limit on the amount of change in superelevation per second (units of speed) when
   travelling at the max speed for the curve. This allows for smooth transition between flat and superelevated
-  track at high speeds. (Default 4 cm/sec ~ 1.5 inches/sec.)
+  track at high speeds. (Default 55 mm/sec / 1.5 in/sec.)
 - ``MinimumSpeed`` -- The minimum speed limit required for superelevation to be added to a curve. Useful for
-  preventing superelevation from being generated in yards. (Default 25 kmh ~ 15 mph.)
+  preventing superelevation from being generated in yards. (Default 25 kmh / 15 mph.)
 - ``MaximumSpeed`` -- The maximum speed limit allowed for superelevation to be added to a curve. This
   is only useful if a route needs multiple sets of superelevation settings. See section below for a
   description on use of multiple superelevation standards. (Default unlimited.)

Source/Orts.Formats.Msts/RouteFile.cs

@@ -20,6 +20,7 @@
 using Orts.Parsers.Msts;
 using System.IO;
 using ORTS.Common;
+using System.Linq;
 
 namespace Orts.Formats.Msts
 {
@@ -131,7 +132,14 @@ public Tr_RouteFile(STFReader stf)
             if (Description == null) throw new STFException(stf, "Missing Description");
             if (RouteStart == null) throw new STFException(stf, "Missing RouteStart");
             if (ForestClearDistance == 0 && RemoveForestTreesFromRoads) Trace.TraceWarning("You must define also ORTSUserPreferenceForestClearDistance to avoid trees on roads");
-            if (SuperElevation.Count <= 0) SuperElevation.Add(new SuperElevationStandard());
+            if (SuperElevation.Count <= 0)
+            {
+                // No superelevation standard defined, create the default one
+                if (SuperElevationHgtpRadiusM != null)
+                    SuperElevation.Add(new SuperElevationStandard(SuperElevationHgtpRadiusM, MilepostUnitsMetric));
+                else
+                    SuperElevation.Add(new SuperElevationStandard(MilepostUnitsMetric));
+            }
         }
 
         public string RouteID;  // ie JAPAN1  - used for TRK file and route folder name
@@ -228,23 +236,57 @@ public string ENVFileName(SeasonType seasonType, WeatherType weatherType)
 
     public class SuperElevationStandard
     {
-        public float MaxFreightUnderbalanceM = float.PositiveInfinity;
-        public float MaxPaxUnderbalanceM = float.PositiveInfinity;
-        public float MinCantM = 0.0125f; // Default 1.25 cm ~ 0.5 inches
-        public float MaxCantM = 0.15f; // Default limit on superelevation is 15 cm ~ 6 inches
-        public float MinSpeedMpS = MpS.FromKpH(25.0f); // Default 25 kmh ~ 15 mph
+        public float MaxFreightUnderbalanceM = float.PositiveInfinity; // Limit to be set elsewhere
+        public float MaxPaxUnderbalanceM = float.PositiveInfinity; // Limit to be set elsewhere
+        public float MinCantM = 0.010f; // Default 10 mm (0.5 inches on imperial routes)
+        public float MaxCantM = 0.180f; // Default limit on superelevation is 180 mm (5 inches on imperial routes)
+        public float MinSpeedMpS = MpS.FromKpH(25.0f); // Default 25 kmh (15 mph on imperial routes)
         public float MaxSpeedMpS = float.PositiveInfinity; // Default unlimited
-        public float PrecisionM = 0.005f; // Default 5 mm ~ 0.2 inches
+        public float PrecisionM = 0.005f; // Default 5 mm (0.25 inches on imperial routes)
         public float RunoffSlope = 0.003f; // Maximum rate of change of superelevation per track length, default 0.3%
-        public float RunoffSpeedMpS = 0.04f; // Maximum rate of change of superelevation per second, default 4 cm / sec ~ 1.5 inches / sec
+        public float RunoffSpeedMpS = 0.055f; // Maximum rate of change of superelevation per second, default 55 mm / sec (1.5 inches / sec on imperial routes)
         public bool UseLegacyCalculation = true; // Should ORTSTrackSuperElevation be used for superelevation calculations?
 
-        public SuperElevationStandard()
+        // Initialize new instance with default values (default metric values)
+        public SuperElevationStandard(bool metric = true)
         {
-            // Initialize new instance with default values
-            MaxFreightUnderbalanceM = 0.05f; // Default 5 cm ~ 2 inches
-            MaxPaxUnderbalanceM = 0.075f; // Default 7.5 cm ~ 3 inches
+            if (metric)
+            {
+                // Set underbalance to millimeter values for metric routes
+                MaxFreightUnderbalanceM = 0.100f; // Default 100 mm
+                MaxPaxUnderbalanceM = 0.150f; // Default 150 mm
+                // Other parameters are already metric by default
+            }
+            else
+            {
+                // Set values in imperial units
+                MaxFreightUnderbalanceM = Me.FromIn(2.0f); // Default 2 inches
+                MaxPaxUnderbalanceM = Me.FromIn(3.0f); // Default 3 inches
+                MinCantM = Me.FromIn(0.5f);
+                MaxCantM = Me.FromIn(6.0f);
+                MinSpeedMpS = MpS.FromMpH(15.0f);
+                PrecisionM = Me.FromIn(0.25f);
+                RunoffSpeedMpS = MpS.FromMpH(0.0852f); // 1.5 inches per second
+            }
         }
+
+        // Initialize new instance from superelevation interpolator
+        // Interpolator X values should be curve radius, Y values amount of superelevation in meters
+        public SuperElevationStandard(Interpolator elevTable, bool metric = true)
+        {
+            MinCantM = elevTable.Y.Min();
+            MaxCantM = elevTable.Y.Max();
+
+            if (!metric)
+            {
+                // Some extra data still required, use imperial units if the route uses it
+                MinSpeedMpS = MpS.FromMpH(15.0f);
+                PrecisionM = Me.FromIn(0.25f);
+                RunoffSpeedMpS = MpS.FromMpH(0.0852f); // 1.5 inches per second
+            }
+        }
+
+        // Read data for new instance using STF format
         public SuperElevationStandard(STFReader stf)
         {
             stf.MustMatch("(");
@@ -268,7 +310,7 @@ public SuperElevationStandard(STFReader stf)
             {
                 if (MaxPaxUnderbalanceM > 10.0f)
                 {
-                    // Neither underbalance has been defined
+                    // Neither underbalance has been defined, assume some defaults
                     MaxFreightUnderbalanceM = 0.05f; // Default 5 cm ~ 2 inches
                     MaxPaxUnderbalanceM = 0.075f; // Default 7.5 cm ~ 3 inches
                 }