Merge branch 'openrails:master' into lights_bugfix

Author: SteelFill

Source/Documentation/Manual/cabs.rst

@@ -785,6 +785,33 @@ can be customized with following line, to be added within the control block in t
 .cvf file::
 
    ORTSLabel ( "string" )
+
+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
+`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.
+
+Note that while these tokens can be used to convert between many units, it is recommended
+to use built in Open Rails units wherever suitable.
 
 Multiple screen pages on displays
 ---------------------------------

Source/Documentation/Manual/features-rollingstock.rst

@@ -1912,8 +1912,18 @@ Use the following .eng parameter to load a circuit breaker script::
   )
 
 ``ORTSCircuitBreaker`` refers to the circuit breaker script in the engine's ``Script`` 
-subfolder. For this field, the .cs extension is optional. "Automatic" and "Manual" load the generic OR 
-circuit breaker implementation, so do `not` use these names for your own script.
+subfolder. For this field, the .cs extension is optional. Alternatively, there are several
+built-in OR circuit breaker implementations:
+
+- "Automatic": no driver intervention required, circuit breaker is closed when conditions are met.
+- "Manual": a circuit breaker switch with open and closed positions.
+- "PushButtons": a circuit breaker with dedicated open and close buttons.
+- "TwoStage": circuit breaker closing is authorized by a switch. If the switch is off, 
+  the circuit breaker is kept open. Once the switch is activated, it is required to use
+  a second button to order the closing.
+
+Please do `not` use these names for your own script, since the generic implementation will
+be loaded instead.
 
 ``ORTSCircuitBreakerClosingDelay`` refers to the delay between the closing command of the circuit breaker
 and the effective closing of the circuit breaker.

Source/Documentation/Manual/news.rst

@@ -5,44 +5,41 @@ New since previous version of Open Rails
 ****************************************
 
 A summary of the new and improved features can be found below. 
-In addition, over 170 bugs have been fixed in this release. 
+In addition, a number of minor bugs have been fixed in this release. 
 
 Please keep `reporting bugs and suggesting new features <http://openrails.org/contribute/reporting-bugs/>`_ 
 so Open Rails can continue to improve.
 
 
-Headlines
----------
-
-- Container Loading and Unloading
-
-
 What's been added
 -----------------
 
-- End Of Train (EOT) devices
-- Distributed Power display, in-cab and on webpage
-- Progress bar for timetable "pre-run"
-- HUD extended for diesel-mechanical loco
-- New features for loco/wagon lighting, including horn-activated flashing ditch lights
-
+- detailed map which tracks player train
+- partial turntables
+- cab controls operated remotely from a tablet or control desk
+- animations for cab windows
+- options to configure RailDriver
+- more accurate wheelslip using Polach adhesion
+- duplex and booster steam engines (e.g. T1 class) 
+- cloud-free skies
+- more air and dynamic brake options for locos
+- mouse control for scripted brake controllers
 
 
 What's been improved
 --------------------
 
-- 64-bit compatibility lifting the 3GB RAM limit
-- Better use of VRAM
-- New default skybox, light, and snowflake assets contributed by community members. Thanks to Erick Cantu, Paul Peterson, and BaldoBi for their contributions!
-
+- sky, sunrise and sunset appearance
+- wheelslip, exhaust and steam
+- layout of map window
+- F9 menu for controlling cars and brakes
+- controls for electric locos
+- air brake features for both European and American brake systems 
+- accurate friction simulation for 4 types of brake shoes
 
 
 Other changes
 --------------------
 
-- F5 key now opens Driver Info window. For HUD, use Alt+F5
-- Some trial options are now always active including:
-
-  - map window (Ctrl+9)
-  - de-brief evaluation (F1)
-  - web server
+- distracting “z-fighting” has been minimised
+- inactive windows are indicated when several windows are open

Source/Menu/Properties/Resources.resx

@@ -122,7 +122,7 @@
     <value>..\Expander-open.png;System.Drawing.Bitmap, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
   </data>
   <data name="ExpanderClosedDisabled" type="System.Resources.ResXFileRef, System.Windows.Forms">
-    <value>..\expander-closed-disabled.png;System.Drawing.Bitmap, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
+    <value>..\Expander-closed-disabled.png;System.Drawing.Bitmap, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
   </data>
   <data name="ExpanderClosed" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>..\Expander-closed.png;System.Drawing.Bitmap, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
@@ -136,4 +136,4 @@
   <data name="info_18_hover" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>..\Resources\info-18-hover.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
   </data>
-</root>
+</root>

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -322,6 +322,8 @@ public enum CABViewControlUnits
         METRES_SEC_SEC,
         KMµHOURµHOUR,
         KM_HOUR_HOUR,
+        KMµHOURµMIN,
+        KM_HOUR_MIN,
         KMµHOURµSEC,
         KM_HOUR_SEC,
         METRESµSECµHOUR,
@@ -468,6 +470,10 @@ 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;
+
         public bool DisabledIfLowVoltagePowerSupplyOff { get; private set; } = false;
         public bool DisabledIfCabPowerSupplyOff { get; private set; } = false;
         public bool HideIfDisabled { get; private set; } = true;
@@ -685,6 +691,9 @@ 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); }),
             });
         }
     }
@@ -781,6 +790,9 @@ 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); }),
             });
         }
     }
@@ -923,6 +935,9 @@ 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); }),
             });
         }
 
@@ -1179,6 +1194,9 @@ 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); }),
                 });
 
                 // If no ACE, just don't need any fixup
@@ -1425,6 +1443,9 @@ 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); }),
             });
         }
         protected int ParseNumStyle(STFReader stf)
@@ -1475,6 +1496,9 @@ 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); }),
             });
         }
         protected int ParseNumStyle(STFReader stf)
@@ -1516,6 +1540,9 @@ 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); }),
             });
         }
         protected void ParseCustomParameters(STFReader stf)

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

@@ -5195,6 +5195,10 @@ public virtual float GetDataOf(CabViewControl cvc)
                                 data = this.AccelerationMpSS * 3.6f;
                                 break;
 
+                            case CABViewControlUnits.KM_HOUR_MIN:
+                                data = this.AccelerationMpSS * 3.6f * 60.0f;
+                                break;
+
                             case CABViewControlUnits.KM_HOUR_HOUR:
                                 data = this.AccelerationMpSS * 3.6f * 3600.0f;
                                 break;
@@ -5216,7 +5220,7 @@ public virtual float GetDataOf(CabViewControl cvc)
                         break;
                     }
 
-                 case CABViewControlTypes.ORTS_WATER_SCOOP:
+                case CABViewControlTypes.ORTS_WATER_SCOOP:
                     data = WaterScoopDown ? 1 : 0;
                     break;
 
@@ -6129,6 +6133,12 @@ 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;
         }