Merge pull request #560 from Csantucci/cabview-control-label

https://blueprints.launchpad.net/or/+spec/label-for-cab-controls , by Jindrich

Author: cjakeman

Source/Documentation/Manual/cabs.rst

@@ -527,6 +527,15 @@ if e.g. the wiper moves from left to right and back, only the frames related
 to the motion from left to right have to be included. For the reverse 
 motion the same frames are used from last to first. SwitchVal can vary from 0 to 1.
 
+Control Labels
+--------------
+
+The string appearing on the screen when the mouse browses over a command control 
+can be customized with following line, to be added within the control block in the 
+.cvf file::
+
+   ORTSLabel ( "string" )
+   
 Multiple screen pages on displays
 ---------------------------------
 

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -406,6 +406,7 @@ public class CabViewControl
 
         public double OldValue;
         public string ACEFile = "";
+        public string Label = "";
 
         public int Display;
         public List<string> Screens;
@@ -607,6 +608,11 @@ public CVCDial(STFReader stf, string basepath)
                     ToDegree = stf.ReadFloat(STFReader.UNITS.None, null);
                     stf.SkipRestOfBlock();
                 }),
+                new STFReader.TokenProcessor("ortslabel", ()=>{
+                    stf.MustMatch("(");
+                    Label = stf.ReadString();
+                    stf.SkipRestOfBlock();
+                }),
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
@@ -696,6 +702,11 @@ public CVCGauge(STFReader stf, string basepath)
                     }
                 }),
                 new STFReader.TokenProcessor("ortsangle", () =>{ Rotation = ParseRotation(stf); }),
+                new STFReader.TokenProcessor("ortslabel", ()=>{
+                    stf.MustMatch("(");
+                    Label = stf.ReadString();
+                    stf.SkipRestOfBlock();
+                }),
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
@@ -822,6 +833,11 @@ public CVCDigital(STFReader stf, string basepath)
                 }),
                 new STFReader.TokenProcessor("ortsfont", ()=>{ParseFont(stf); }),
                 new STFReader.TokenProcessor("ortsangle", () => {Rotation = ParseRotation(stf); }),
+                new STFReader.TokenProcessor("ortslabel", ()=>{
+                    stf.MustMatch("(");
+                    Label = stf.ReadString();
+                    stf.SkipRestOfBlock();
+                }),
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
@@ -1066,6 +1082,11 @@ public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
                             _ValuesRead++;
                         }
                     }),
+                new STFReader.TokenProcessor("ortslabel", ()=>{
+                    stf.MustMatch("(");
+                    Label = stf.ReadString();
+                    stf.SkipRestOfBlock();
+                }),
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortsnewscreenpage", () => {ParseNewScreen(stf); }),

Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs

@@ -1579,7 +1579,7 @@ public interface ICabViewMouseControlRenderer
         bool IsMouseWithin();
         void HandleUserInput();
         string GetControlName();
-
+        string ControlLabel { get; }
     }
 
     /// <summary>
@@ -2215,6 +2215,8 @@ public string GetControlName()
             return (Locomotive as MSTSLocomotive).TrainControlSystem.GetDisplayString(GetControlType().ToString());
         }
 
+        public string ControlLabel => Control.Label;
+
         /// <summary>
         /// Handles cabview mouse events, and changes the corresponding locomotive control values.
         /// </summary>

Source/RunActivity/Viewer3D/RollingStock/SubSystems/ETCS/DriverMachineInterface.cs

@@ -856,7 +856,7 @@ public string GetControlName()
             }
             return "";
         }
-
+        public string ControlLabel => GetControlName();
         public override void Draw(GraphicsDevice graphicsDevice)
         {
             DMI.Draw(ControlView.SpriteBatch, new Point(DrawPosition.X, DrawPosition.Y));

Source/RunActivity/Viewer3D/Viewer.cs

@@ -1477,7 +1477,7 @@ void HandleUserInput(ElapsedTime elapsedTime)
                     if (MousePickedControl != null & MousePickedControl != OldMousePickedControl)
                     {
                         // say what control you have here
-                        Simulator.Confirmer.Message(ConfirmLevel.None, MousePickedControl.GetControlName());
+                        Simulator.Confirmer.Message(ConfirmLevel.None, String.IsNullOrEmpty(MousePickedControl.ControlLabel) ? MousePickedControl.GetControlName() : MousePickedControl.ControlLabel);
                     }
                     if (MousePickedControl != null) ActualCursor = Cursors.Hand;
                     else if (ActualCursor == Cursors.Hand) ActualCursor = Cursors.Default;
@@ -1636,7 +1636,7 @@ void HandleUserInput(ElapsedTime elapsedTime)
                     if (MousePickedControl != null & MousePickedControl != OldMousePickedControl)
                     {
                         // say what control you have here
-                        Simulator.Confirmer.Message(ConfirmLevel.None, MousePickedControl.GetControlName());
+                        Simulator.Confirmer.Message(ConfirmLevel.None, String.IsNullOrEmpty(MousePickedControl.ControlLabel) ? MousePickedControl.GetControlName() : MousePickedControl.ControlLabel);
                     }
                     if (MousePickedControl != null)
                     {