Improve dynamic track superelevation

Author: SteelFill

Source/Orts.Simulation/Simulation/RollingStocks/TrainCar.cs

@@ -1952,7 +1952,11 @@ public virtual void UpdateCurveSpeedLimit(float elapsedClockSeconds)
                 // If speed exceeds the overturning speed, then indicated that an error condition has been reached.
                 if (s > CriticalMaxSpeedMpS)
                 {
-                    if (!IsCriticalMaxSpeed)
+                    // Consider a tolerance so error isn't immediately thrown, should reduce overkill notifications on routes with jerky track laying
+                    // Will be reduced faster if simultaneously above the max safe speed
+                    ComfortTolerance -= 0.25f * (s / MaxSafeCurveSpeedMps - 1.0f) * elapsedClockSeconds;
+
+                    if (!IsCriticalMaxSpeed && ComfortTolerance <= 0.0f)
                     {
                         IsCriticalMaxSpeed = true; // set flag for IsCriticalSpeed reached
 
@@ -2896,7 +2900,10 @@ public void UpdateCurvePhys(Traveller traveller, float[] offsets)
             // Set superelevation angle used by physics system
             SuperElevationAngleRad = (float)Math.Asin(SuperelevationM / TrackGaugeM);
 
-            CurrentCurveRadiusM = curveRadii.Min();
+            CurrentCurveRadiusM = curveRadii.Average();
+            // Straight track has a "radius" of infinity, but rest of code expects straight to have a "radius" of 0
+            if (CurrentCurveRadiusM == float.PositiveInfinity)
+                CurrentCurveRadiusM = 0;
         }
         #endregion
 

Source/Orts.Simulation/Simulation/SuperElevation.cs

@@ -162,63 +162,64 @@ void MarkSections(Simulator simulator, List<TrVectorSection> SectionList, float
             if (standard == null)
             {
                 foreach (TrVectorSection s in SectionList)
-                    s.NomElevM = 0;
-                return; // No superelevation needed, stop processing here
+                    s.NomElevM = 0; // No superelevation needed
             }
-            if ((standard.MinCantM / effectiveRunoffSlope) * 2.0f > totLen * 0.75f)
+            else if ((standard.MinCantM / effectiveRunoffSlope) * 2.0f > totLen * 0.75f)
             {
                 foreach (TrVectorSection s in SectionList)
-                    s.NomElevM = 0;
-                return; // Curve is so short that no meaningful superelevation can be applied
+                    s.NomElevM = 0; // Curve is so short that no meaningful superelevation can be applied
             }
-
-            // Determine proper level of superelevation for every section
-            for (int i = 0; i < SectionList.Count; i++)
+            else
             {
-                // Superelevation has not been calculated for this section yet
-                if (SectionList[i].NomElevM < 0.0f)
+                // Superelevation can be applied, run calculations
+                foreach (TrVectorSection s in SectionList)
                 {
-                    var sectionData = simulator.TSectionDat.TrackSections.Get(SectionList[i].SectionIndex);
-
-                    if (sectionData == null || sectionData.SectionCurve == null)
+                    // Superelevation has not been calculated for this section yet
+                    // FUTURE: Superelevation NomElevM may be specified externally, eg: by a route editor
+                    if (s.NomElevM < 0.0f)
                     {
-                        SectionList[i].NomElevM = 0.0f;
-                        continue;
-                    }
-                    else
-                    {
-                        float superElevation;
+                        var sectionData = simulator.TSectionDat.TrackSections.Get(s.SectionIndex);
 
-                        // Support for old system with superelevation set directly in Route (TRK) file
-                        if (standard.UseLegacyCalculation && simulator.TRK.Tr_RouteFile.SuperElevationHgtpRadiusM != null)
+                        if (sectionData == null || sectionData.SectionCurve == null)
                         {
-                            superElevation = simulator.TRK.Tr_RouteFile.SuperElevationHgtpRadiusM[sectionData.SectionCurve.Radius];
+                            s.NomElevM = 0.0f;
+                            continue;
                         }
-                        else // Newer standard for calculating superelevation
+                        else
                         {
-                            if (standard != null)
-                            {
-                                float paxSpeed = SectionList[i].PassSpeedMpS;
-                                float freightSpeed = SectionList[i].FreightSpeedMpS;
-
-                                // Approximate ideal level of superelevation determined using E = (G*V^2) / (g*R), then subtract off cant deficiency
-                                // For different speeds on the same curve, we can factor out speed and get a constant c = G / (g*R)
-                                float elevationFactor = simulator.SuperElevationGauge / (9.81f * sectionData.SectionCurve.Radius);
-                                // Calculate required superelevation for passenger and freight separately
-                                float paxElevation = elevationFactor * (paxSpeed * paxSpeed) - standard.MaxPaxUnderbalanceM;
-                                float freightElevation = elevationFactor * (freightSpeed * freightSpeed) - standard.MaxFreightUnderbalanceM;
+                            float superElevation;
 
-                                superElevation = Math.Max(paxElevation, freightElevation); // Choose the highest required superelevation
+                            // Support for old system with superelevation set directly in Route (TRK) file
+                            if (standard.UseLegacyCalculation && simulator.TRK.Tr_RouteFile.SuperElevationHgtpRadiusM != null)
+                            {
+                                superElevation = simulator.TRK.Tr_RouteFile.SuperElevationHgtpRadiusM[sectionData.SectionCurve.Radius];
                             }
-                            else // No superelevation needed (shouldn't reach this point, this is a failsafe)
-                                superElevation = 0.0f;
-                        }
-                        superElevation = (float)Math.Round(superElevation / standard.PrecisionM, MidpointRounding.AwayFromZero)
-                            * standard.PrecisionM; // Round superelevation amount to next higher increment of precision
+                            else // Newer standard for calculating superelevation
+                            {
+                                if (standard != null)
+                                {
+                                    float paxSpeed = s.PassSpeedMpS;
+                                    float freightSpeed = s.FreightSpeedMpS;
+
+                                    // Approximate ideal level of superelevation determined using E = (G*V^2) / (g*R), then subtract off cant deficiency
+                                    // For different speeds on the same curve, we can factor out speed and get a constant c = G / (g*R)
+                                    float elevationFactor = simulator.SuperElevationGauge / (9.81f * sectionData.SectionCurve.Radius);
+                                    // Calculate required superelevation for passenger and freight separately
+                                    float paxElevation = elevationFactor * (paxSpeed * paxSpeed) - standard.MaxPaxUnderbalanceM;
+                                    float freightElevation = elevationFactor * (freightSpeed * freightSpeed) - standard.MaxFreightUnderbalanceM;
+
+                                    superElevation = Math.Max(paxElevation, freightElevation); // Choose the highest required superelevation
+                                }
+                                else // No superelevation needed (shouldn't reach this point, this is a failsafe)
+                                    superElevation = 0.0f;
+                            }
+                            superElevation = (float)Math.Round(superElevation / standard.PrecisionM, MidpointRounding.AwayFromZero)
+                                * standard.PrecisionM; // Round superelevation amount to next higher increment of precision
 
-                        superElevation = MathHelper.Clamp(superElevation, standard.MinCantM, maxElev);
+                            superElevation = MathHelper.Clamp(superElevation, standard.MinCantM, maxElev);
 
-                        SectionList[i].NomElevM = superElevation;
+                            s.NomElevM = superElevation;
+                        }
                     }
                 }
             }

Source/Orts.Simulation/Simulation/Traveller.cs

@@ -980,7 +980,7 @@ public float GetCurvature()
         public void GetCurveData(out float physicsElev, out float curveRadius)
         {
             physicsElev = 0;
-            curveRadius = 0;
+            curveRadius = float.PositiveInfinity;
 
             if (trackSection == null || trackVectorSection == null)
                 return;

Source/RunActivity/Viewer3D/Scenery.cs

@@ -376,20 +376,22 @@ public WorldFile(Viewer viewer, int tileX, int tileZ, bool visible)
                         // We might not have found the junction node; if so, fall back to the static track shape.
                         if (trJunctionNode != null)
                         {
+                            // Handle superelevation on junctions (usually this means disabling it)
                             if (viewer.Simulator.UseSuperElevation)
-                                SuperElevationManager.DecomposeStaticSuperElevation(viewer, dTrackList, trackObj, worldMatrix, TileX, TileZ, shapeFilePath);
+                                SuperElevationManager.PrepareStaticSuperElevation(viewer, trackObj, TileX, TileZ, shapeFilePath);
                             sceneryObjects.Add(new SwitchTrackShape(viewer, shapeFilePath, worldMatrix, trJunctionNode));
                         }
                         else
                         {
-                            //if want to use super elevation, we will generate tracks using dynamic tracks
+                            // See if superelevation should be used on this piece of track
                             if (viewer.Simulator.UseSuperElevation
-                                && SuperElevationManager.DecomposeStaticSuperElevation(viewer, dTrackList, trackObj, worldMatrix, TileX, TileZ, shapeFilePath))
+                                && SuperElevationManager.PrepareStaticSuperElevation(viewer, trackObj, TileX, TileZ, shapeFilePath))
                             {
-                                // No need to add shapes for this segment of track
+                                // Don't add scenery for this section of track, dynamic superelevated track will be created instead
                             }
-                            //otherwise, use shapes
-                            else if (!containsMovingTable) sceneryObjects.Add(new StaticTrackShape(viewer, shapeFilePath, worldMatrix));
+                            // No superelevation, use shapes
+                            else if (!containsMovingTable)
+                                sceneryObjects.Add(new StaticTrackShape(viewer, shapeFilePath, worldMatrix));
                             else
                             {
                                 var found = false;
@@ -429,22 +431,24 @@ public WorldFile(Viewer viewer, int tileX, int tileZ, bool visible)
                     }
                     else if (worldObject.GetType() == typeof(DyntrackObj))
                     {
+                        // Dynamic track will require track profiles, set up track profiles if not yet set
                         if (viewer.TRPs == null)
                         {
-                            // First to need a track profile creates it
                             Trace.Write(" TRP");
-                            // Creates profile and loads materials into SceneryMaterials
+                            // Creates profile(s) and loads materials into SceneryMaterials
                             TRPFile.CreateTrackProfile(viewer, viewer.Simulator.RoutePath, out viewer.TRPs);
                         }
 
                         if (viewer.Simulator.Settings.Wire == true && viewer.Simulator.TRK.Tr_RouteFile.Electrified == true)
                             Wire.DecomposeDynamicWire(viewer, dTrackList, (DyntrackObj)worldObject, worldMatrix);
                         // Add DyntrackDrawers for individual subsections
-                        if (viewer.Simulator.UseSuperElevation && SuperElevationManager.UseSuperElevationDyn(viewer, dTrackList, (DyntrackObj)worldObject, worldMatrix))
+                        if (viewer.Simulator.UseSuperElevation && SuperElevationManager.UseSuperElevationDyn((DyntrackObj)worldObject))
                             SuperElevationManager.DecomposeDynamicSuperElevation(viewer, dTrackList, (DyntrackObj)worldObject, worldMatrix);
-                        else DynamicTrack.Decompose(viewer, dTrackList, (DyntrackObj)worldObject, worldMatrix);
+                        else
+                            DynamicTrack.Decompose(viewer, dTrackList, (DyntrackObj)worldObject, worldMatrix);
 
-                    } // end else if DyntrackObj
+                    }
+                    // Objects other than tracks
                     else if (worldObject.GetType() == typeof(ForestObj))
                     {
                         if (!(worldObject as ForestObj).IsYard)
@@ -593,8 +597,9 @@ public WorldFile(Viewer viewer, int tileX, int tileZ, bool visible)
                 }
             }
 
-            if (viewer.Simulator.UseSuperElevation) SuperElevationManager.DecomposeStaticSuperElevation(Viewer, dTrackList, TileX, TileZ);
-            if (Viewer.World.Sounds != null) Viewer.World.Sounds.AddByTile(TileX, TileZ);
+            if (viewer.Simulator.UseSuperElevation)
+                SuperElevationManager.DecomposeTileSuperElevation(Viewer, dTrackList, TileX, TileZ);
+            Viewer.World.Sounds?.AddByTile(TileX, TileZ);
         }
 
         /// <summary>