Update frame rate so that it is always visible and not just when HuD is switched on.

Author: peternewell

Source/Orts.Simulation/Simulation/Physics/Train.cs

@@ -195,8 +195,6 @@ public int ActivityDurationS
 
         public bool HasControlCarWithGear = false;
 
-        public float ScreenFrameRate;
-
         //To investigate coupler breaks on route
         private bool numOfCouplerBreaksNoted = false;
         public static int NumOfCouplerBreaks = 0;//Debrief Eval

Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs

@@ -2807,7 +2807,6 @@ public virtual void AdvancedAdhesion(float elapsedClockSeconds)
                 axle.CurrentCurveRadiusM = CurrentCurveRadiusM;
                 axle.BogieRigidWheelBaseM = RigidWheelBaseM;
                 axle.CurtiusKnifflerZeroSpeed = ZeroSpeedAdhesionBase;
-                axle.ScreenFrameRate = Train.ScreenFrameRate;
             }
 
             LocomotiveAxles.Update(elapsedClockSeconds);

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerTransmissions/Axle.cs

@@ -519,11 +519,6 @@ public float TransmissionEfficiency
         /// </summary>
         public float CurtiusKnifflerZeroSpeed;
 
-        /// <summary>
-        /// Simulator FPS
-        /// </summary>
-        public float ScreenFrameRate;
-
         /// <summary>
         /// Wheel adhesion as calculated by Polach
         /// </summary>
@@ -863,6 +858,8 @@ void Integrate(float elapsedClockSeconds)
             float screenFrameUpperLimit = 60;
             float screenFrameLowerLimit = 40;
 
+            var ScreenFrameRate = Simulator.SmoothedFrameRate;
+
             // Reduces the number of substeps if screen FPS drops below a nominal rate of 60 fps
             if ( (int)ScreenFrameRate >= screenFrameUpperLimit) // Screen FPS > 60, hold substeps @ maximum value
             {

Source/Orts.Simulation/Simulation/Simulator.cs

@@ -32,10 +32,12 @@
 using ORTS.Common;
 using ORTS.Scripting.Api;
 using ORTS.Settings;
+using SharpDX.MediaFoundation;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.Runtime.Remoting.Messaging;
 using Event = Orts.Common.Event;
 
 namespace Orts.Simulation
@@ -58,6 +60,20 @@ namespace Orts.Simulation
     /// </summary>
     public class Simulator
     {
+        /// <summary>
+        ///  Sets the frame rate object so its value can be read from anywhere in the Simulator and used to tune simulation algorithms.
+        /// </summary>
+        /// <param name="frameRate"></param>
+        public static void SetFrameRate(SmoothedData frameRate)
+        {
+            FrameRate = frameRate;
+        }
+        public static float SmoothedFrameRate
+        {
+            get { return FrameRate.SmoothedValue; }
+        }
+        private static SmoothedData FrameRate;
+
         public static GettextResourceManager Catalog { get; private set; }
         public static Random Random { get; private set; }
         public static double Resolution = 1000000; // resolution for calculation of random value with a pseudo-gaussian distribution
@@ -1355,8 +1371,8 @@ private Train InitializePlayerTrain()
             train.AITrainBrakePercent = 100; //<CSComment> This seems a tricky way for the brake modules to test if it is an AI train or not
             train.EqualReservoirPressurePSIorInHg = prevEQres; // The previous command modifies EQ reservoir pressure, causing issues with EP brake systems, so restore to prev value
 
-//            if ((PlayerLocomotive as MSTSLocomotive).EOTEnabled != MSTSLocomotive.EOTenabled.no)
-//                train.EOT = new EOT((PlayerLocomotive as MSTSLocomotive).EOTEnabled, false, train);
+            //            if ((PlayerLocomotive as MSTSLocomotive).EOTEnabled != MSTSLocomotive.EOTenabled.no)
+            //                train.EOT = new EOT((PlayerLocomotive as MSTSLocomotive).EOTEnabled, false, train);
 
             return (train);
         }
@@ -1432,8 +1448,8 @@ private AITrain InitializeAPPlayerTrain()
 
             if (conFileName.Contains("tilted")) train.IsTilting = true;
 
-//            if ((PlayerLocomotive as MSTSLocomotive).EOTEnabled != MSTSLocomotive.EOTenabled.no)
-//                train.EOT = new EOT((PlayerLocomotive as MSTSLocomotive).EOTEnabled, false, train);
+            //            if ((PlayerLocomotive as MSTSLocomotive).EOTEnabled != MSTSLocomotive.EOTenabled.no)
+            //                train.EOT = new EOT((PlayerLocomotive as MSTSLocomotive).EOTEnabled, false, train);
 
             return train;
         }
@@ -1487,7 +1503,7 @@ private void InitializeStaticConsists()
 
                         if (!File.Exists(wagonFilePath))
                         {
-                            Trace.TraceWarning($"Ignored missing {(wagon.IsEngine? "engine" : "wagon")} {wagonFilePath} in activity definition {activityObject.Train_Config.TrainCfg.Name}");
+                            Trace.TraceWarning($"Ignored missing {(wagon.IsEngine ? "engine" : "wagon")} {wagonFilePath} in activity definition {activityObject.Train_Config.TrainCfg.Name}");
                             continue;
                         }
 
@@ -1897,7 +1913,7 @@ private void StartSwitchPlayerTrain()
                     if (playerTrain != null)
                     {
                         if (playerTrain.ControlMode == Train.TRAIN_CONTROL.MANUAL) TrainSwitcher.SuspendOldPlayer = true; // force suspend state to avoid disappearing of train;
-                        if (TrainSwitcher.SuspendOldPlayer && 
+                        if (TrainSwitcher.SuspendOldPlayer &&
                             (playerTrain.SpeedMpS < -0.025 || playerTrain.SpeedMpS > 0.025 || playerTrain.PresentPosition[0].TCOffset != playerTrain.PreviousPosition[0].TCOffset))
                         {
                             Confirmer.Message(ConfirmLevel.Warning, Catalog.GetString("Train can't be suspended with speed not equal 0"));
@@ -2116,10 +2132,10 @@ public void RestartWaitingTrain(RestartWaitingTrain restartWaitingTrain)
                 }
             }
             if (trainToRestart == null)
-                Trace.TraceWarning("Train {0} to restart not found", restartWaitingTrain.WaitingTrainToRestart);            
+                Trace.TraceWarning("Train {0} to restart not found", restartWaitingTrain.WaitingTrainToRestart);
         }
 
- 
+
 
         /// <summary>
         /// Derive log-file name from route path and activity name

Source/RunActivity/Viewer3D/Popups/HUDWindow.cs

@@ -474,10 +474,6 @@ void TextPageCommon(TableData table)
             TableAddLabelValue(table, Viewer.Catalog.GetString("FPS"), "{0:F0}", Viewer.RenderProcess.FrameRate.SmoothedValue);
             TableAddLine(table);
 
-            // Used in axle module to adjust substeps for frame rate drops
-            var mstsLocomotive = Viewer.PlayerLocomotive as MSTSLocomotive;
-            Viewer.PlayerTrain.ScreenFrameRate = Viewer.RenderProcess.FrameRate.SmoothedValue;
-
             if (Viewer.PlayerLocomotive.Train.TrainType == Train.TRAINTYPE.AI_PLAYERHOSTING)
                 TableAddLine(table, Viewer.Catalog.GetString("Autopilot") + "???");
 

Source/RunActivity/Viewer3D/Viewer.cs

@@ -363,6 +363,8 @@ public Viewer(Simulator simulator, Orts.Viewer3D.Processes.Game game)
                     SpeedpostDatFile = new SpeedpostDatFile(Simulator.RoutePath + @"\speedpost.dat", Simulator.RoutePath + @"\shapes\");
                 }
             }
+            // So the frame rate can be read from anywhere in the Simulator and used to tune simulation algorithms.
+            Simulator.SetFrameRate(this.RenderProcess.FrameRate);
 
             Initialize();
         }