Automatic merge of T1.5.1-1197-g092fac25e3 and 15 pull requests

- Pull request #959 at 2452cb0: Fix TrackViewer crash on big zoom value
- 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 e715fa4: 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 #974 at 5faea6f: Bug fix for https://bugs.launchpad.net/or/+bug/2076034 Doors remain open in AI trains
- Pull request #980 at a7406de: Downloading route content (Github, zip) second part 
- 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/How to Provide Track Profiles for Open Rails Dynamic Track.docm

@@ -952,20 +952,32 @@ and a third standard for 160 kph and up, the required Minimum/MaximumSpeed setti
 Note that the order of the ``ORTSSuperElevation`` blocks is important; they are read from top down
 so the slowest superelevation standard should be on top of all faster superelevation standards.
 
-Open Rails also supports a simpler but less accurate way to define superelevation. It is
-recommended to not use this system as it does not follow the principles of real superelevation
-design, producing less accurate results. However, it has been retained to support prior routes.
+Open Rails also supports a simpler but less modern way to define superelevation based on curve
+radius only, without consideration for underbalance. This method may be appropriate for railroads
+built long in the past and will not produce the best results for modern routes.
 The parameter ``ORTSTrackSuperElevation`` can be added to the .trk file to define a table
 of superelevation values::
 
-   ORTSTrackSuperElevation ( x y .......... )
+    ORTSTrackSuperElevation (
+        x1 y1
+        x2 y2
+        ........
+    )
    
-where x and y are a series of paired parameters specifying the curve radius in metres (x value),
-and the amount of superelevation in metres (y value). The statement will take as many paired 
-values as desired. Each paired set of values must have an x and y value present. If it is desired
+where x and y are a series of paired parameters specifying the curve radius (default meters)
+(x value), and the amount of superelevation (default meters) (y value). The statement will take
+as many paired values as desired, as long as the radius values are in increasing order.
+Each paired set of values must have an x and y value present. If it is desired
 to 'hold' a certain value of SuperElevation for a number of different radii curves, then the same 
 y value needs to be used for succeeding values of curve radius. Where the y value changes between 
-curve radii, then Open Rails will extrapolate the y value between the two points. 
+curve radii, then Open Rails will interpolate the y value between the two points.
+
+Superelevation calculated using ``ORTSSuperElevation`` will generally override any values
+entered in ``ORTSTrackSuperElevation`` unless the ``ORTSSuperElevation`` block did not specify
+a value for ``MaxFreightUnderbalance`` or ``MaxPassengerUnderbalance``. If neither is given,
+superelevation will be replaced with the value given by ``ORTSTrackSuperElevation``, but will
+be adjusted to match the given values of minimum and maximum cant, precision, and runoff. This
+way, it is possible to represent a wide variety of superelevation configurations.
 
 
 Overhead (catenary) wire

Source/Documentation/Manual/features-route.rst

@@ -345,7 +345,7 @@ orderby folder.Key
             numericPerformanceTunerTarget.Enabled = checkPerformanceTuner.Checked;
 
             // Experimental tab
-            numericUseSuperElevation.Value = Settings.UseSuperElevation;
+            checkUseSuperElevation.Checked = Settings.UseSuperElevation;
             numericSuperElevationGauge.Value = Settings.SuperElevationGauge;
             trackLODBias.Value = Settings.LODBias;
             trackLODBias_ValueChanged(null, null);
@@ -537,7 +537,7 @@ void buttonOK_Click(object sender, EventArgs e)
             Settings.PerformanceTunerTarget = (int)numericPerformanceTunerTarget.Value;
 
             // Experimental tab
-            Settings.UseSuperElevation = (int)numericUseSuperElevation.Value;
+            Settings.UseSuperElevation = checkUseSuperElevation.Checked;
             Settings.SuperElevationGauge = (int)numericSuperElevationGauge.Value;
             Settings.LODBias = trackLODBias.Value;
             Settings.SignalLightGlow = checkSignalLightGlow.Checked;

Source/Menu/Options.Designer.cs

@@ -290,7 +290,7 @@ public enum DirectXFeature
 
         // Experimental settings:
         [Default(0)]
-        public int UseSuperElevation { get; set; }
+        public bool UseSuperElevation { get; set; }
         [Default(1435)]
         public int SuperElevationGauge { get; set; }
         [Default(0)]

Source/Menu/Options.cs

@@ -132,7 +132,6 @@ public Tr_RouteFile(STFReader stf)
             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());
-            else SuperElevationHgtpRadiusM = null; // Disable legacy superelevation system if newer system is defined
         }
 
         public string RouteID;  // ie JAPAN1  - used for TRK file and route folder name
@@ -232,12 +231,13 @@ 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 = -1.0f; // Specified by user settings by default
+        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 MaxSpeedMpS = float.PositiveInfinity; // Default unlimited
         public float PrecisionM = 0.005f; // Default 5 mm ~ 0.2 inches
         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 bool UseLegacyCalculation = true; // Should ORTSTrackSuperElevation be used for superelevation calculations?
 
         public SuperElevationStandard()
         {
@@ -260,6 +260,9 @@ public SuperElevationStandard(STFReader stf)
                 new STFReader.TokenProcessor("maxrunoffspeed", () => { RunoffSpeedMpS = stf.ReadFloatBlock(STFReader.UNITS.Speed, null); }),
             });
 
+            // Disable legacy superelevation calculations if sufficient data is given
+            if (MaxFreightUnderbalanceM <= 10.0f || MaxPaxUnderbalanceM <= 10.0f)
+                UseLegacyCalculation = false;
             // Sanity check values of underbalance
             if (MaxFreightUnderbalanceM > 10.0f)
             {