Add exponential unit override, remove change to dynamic brake display to a future PR

Author: SteelFill

Source/Documentation/Manual/cabs.rst

@@ -791,15 +791,22 @@ Custom Display Units
 
 Due to the wide variety of railroad equipment across the world, Open Rails may not
 provide the units of measure needed for a cabview control. In this case, the tokens
-`ORTSUnitsScaleFactor` and `ORTSUnitsOffset` can be added to the control block in
-the .cvf file to create the units of measure required for the cab view.
-
-- ORTSUnitsScaleFactor ( x ): Multiplies the value shown by the cab view control
-  by a factor of x, allowing for arbitrary conversion of units of measure. For
-  example, a cab view control displaying MILES_PER_HOUR with ORTSUnitsScaleFactor ( 1.467 )
-  would instead display a value equivalent to feet per second.
-- ORTSUnitsOffset ( x ): After applying the scale factor, adds x to the value shown
-  by the cab view control. To subtract from the shown value, set x to a negative number.
+`ORTSUnitsExponent`, `ORTSUnitsScaleFactor`, and `ORTSUnitsOffset` can be added
+to the control block in the .cvf file to create the units of measure required for
+the cab view.
+
+- ORTSUnitsExponent ( x ): Raises the value shown by the cab view control to the
+  power of x, which may be used to calibrate nonlinear gauges or complete nonlinear
+  conversions. Fractional and negative values are allowed. For example, an accelerometer
+  gauge with ORTSUnitsExponent ( 0.5 ) would change the accelerometer to be more sensitive
+  to small accelerations, but less sensitive to large acceleration. (However, the values
+  shown would not be in any meaningful units.)
+- ORTSUnitsScaleFactor ( y ): After accounting for any exponent, multiplies the value
+  shown by the cab view control by a factor of y, allowing for arbitrary conversion of
+  units of measure. For example, a cab view control displaying MILES_PER_HOUR with
+  ORTSUnitsScaleFactor ( 1.467 ) would instead display a value equivalent to feet per second.
+- ORTSUnitsOffset ( z ): After applying the scale factor, adds z to the value shown
+  by the cab view control. To subtract from the shown value, set z to a negative number.
   For example, a cab view control with units of BAR and ORTSUnitsOffset ( 0.987 ) would show
   pressure as absolute pressure, rather than gauge pressure.
 

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -470,6 +470,7 @@ public class CabViewControl
         public CABViewControlStyles ControlStyle = CABViewControlStyles.NONE;
         public CABViewControlUnits Units = CABViewControlUnits.NONE;
 
+        public double UnitsExponent = 1.0f;
         public float UnitsScale = 1.0f;
         public float UnitsOffset;
 
@@ -690,6 +691,7 @@ public CVCDial(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
+                new STFReader.TokenProcessor("ortsunitsexponent", ()=>{ UnitsExponent = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsscalefactor", ()=>{ UnitsScale = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsoffset", ()=>{ UnitsOffset = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
             });
@@ -788,6 +790,7 @@ public CVCGauge(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
+                new STFReader.TokenProcessor("ortsunitsexponent", ()=>{ UnitsExponent = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsscalefactor", ()=>{ UnitsScale = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsoffset", ()=>{ UnitsOffset = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
             });
@@ -932,6 +935,7 @@ public CVCDigital(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
+                new STFReader.TokenProcessor("ortsunitsexponent", ()=>{ UnitsExponent = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsscalefactor", ()=>{ UnitsScale = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsoffset", ()=>{ UnitsOffset = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
             });
@@ -1190,6 +1194,7 @@ public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
                 new STFReader.TokenProcessor("ortsnewscreenpage", () => {ParseNewScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
                 new STFReader.TokenProcessor("ortsparameter1", ()=>{ Parameter1 = stf.ReadFloatBlock(STFReader.UNITS.Any, 0); }),
+                new STFReader.TokenProcessor("ortsunitsexponent", ()=>{ UnitsExponent = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsscalefactor", ()=>{ UnitsScale = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsoffset", ()=>{ UnitsOffset = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 });
@@ -1438,6 +1443,7 @@ public CVCMultiStateDisplay(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
+                new STFReader.TokenProcessor("ortsunitsexponent", ()=>{ UnitsExponent = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsscalefactor", ()=>{ UnitsScale = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsoffset", ()=>{ UnitsOffset = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
             });
@@ -1490,6 +1496,7 @@ public CVCAnimatedDisplay(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
+                new STFReader.TokenProcessor("ortsunitsexponent", ()=>{ UnitsExponent = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsscalefactor", ()=>{ UnitsScale = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsoffset", ()=>{ UnitsOffset = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
             });
@@ -1533,6 +1540,7 @@ public CVCScreen(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
+                new STFReader.TokenProcessor("ortsunitsexponent", ()=>{ UnitsExponent = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsscalefactor", ()=>{ UnitsScale = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 new STFReader.TokenProcessor("ortsunitsoffset", ()=>{ UnitsOffset = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
             });

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

@@ -6133,7 +6133,10 @@ public virtual float GetDataOf(CabViewControl cvc)
                         data = Train.EOT.GetDataOf(cvc);
                     break;
             }
-
+            // Don't waste time calculating exponents if one isn't set
+            // To avoid potential imaginary numbers, use data's absolute value
+            if (cvc.UnitsExponent != 1.0f)
+                data = Math.Sign(data)*(float)Math.Pow(Math.Abs(data), cvc.UnitsExponent);
             data = cvc.UnitsOffset + (data * cvc.UnitsScale);
 
             return data;

Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs

@@ -2147,7 +2147,7 @@ public virtual int GetDrawIndex()
                         {
                             if (Locomotive.CruiseControl != null)
                             {
-                                if (Locomotive.CruiseControl.SpeedRegMode == Simulation.RollingStocks.SubSystems.CruiseControl.SpeedRegulatorMode.Auto && !Locomotive.CruiseControl.DynamicBrakePriority)
+                                if ((Locomotive.CruiseControl.SpeedRegMode == Simulation.RollingStocks.SubSystems.CruiseControl.SpeedRegulatorMode.Auto && !Locomotive.CruiseControl.DynamicBrakePriority) || Locomotive.DynamicBrakeIntervention > 0)
                                 {
                                     index = 0;
                                 }