Merge remote-tracking branch 'upstream/master'

Author: cjakeman

Source/Documentation/Manual/cabs.rst

@@ -466,6 +466,60 @@ 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.
 
+Multiple screen pages on displays
+---------------------------------
+
+Modern locomotives have one or more displays in their cabs, and often in such 
+displays it is possible to switch among more screen pages. Fields and controls 
+described in this paragraph enable the implementation of .cvf files with such 
+functionality, for both 2D and 3D cabs.
+
+In the .cvf control blocks following further fields may be optionally present::
+
+  ORTSDisplay ( numeric ), indicating the display ID number (from 0 to 7) 
+  to which the control is linked; if such field is missing, display ID number 
+  zero is assumed;
+
+  ORTSScreenPage ( alphanumeric-string ) indicating the screen ID string to 
+  which the control is linked; that means that the control is displayed/may be 
+  operated only if its screen is active in that moment; a missing entry 
+  indicates that the control is displayed independently from the selected screen page; 
+  at game start such controls are enabled, plus the ones with line 
+  ORTSScreenPage ( "default" ); more ORTSScreenPage() entries in a single control 
+  are possible.
+
+A new on/off control, called ORTS_SCREEN_SELECT is available, which, in addition to the usual fields and to 
+the optional fields ORTSDisplay and ORTSScreenPage contains one or more of following fields::
+
+  ORTSNewScreenPage ( alphanumeric-string numeric ): when the control is clicked, 
+  the controls with field ORTSScreenPage equal to the string of this field and 
+  with field ORTSDisplay equal to the numeric will be displayed on such display 
+  in place of the ones displayed up to that moment. if the numeric is missing within 
+  ORTSNewScreenPage, the involved display is the one referenced in field ORTSDisplay 
+  of ORTS_SCREEN_SELECT.
+
+A further control is available, named ORTS_STATIC_DISPLAY, which is specially devoted to the loading of the 
+background of screen pages (their static part). 
+Here is an example of usage of it::
+
+	MultiStateDisplay (
+		Type ( ORTS_STATIC_DISPLAY MULTI_STATE_DISPLAY )
+		Position ( 246 151 105 16 )
+		Graphic ( semproniostatic.ace )
+		States ( 1 1 1
+			State (
+				Style ( 0 )
+				SwitchVal ( 0 )
+			)
+		)
+			ORTSScreenPage ( "sempronio" )
+		)
+
+With this block, the static part of the "sempronio" screen page is loaded on display 0 when such screen 
+becomes the active one.
+
+.cvf files not using fields and controls listed in this paragraph work as usual, with no changes needed. 
+
 Further OR cab controls
 -----------------------
 
@@ -480,6 +534,36 @@ and the mirrors.
 The control blocks are like the one shown for the cab light. The Type strings 
 are ORTS_LEFTDOOR, ORTS_RIGHTDOOR and ORTS_MIRRORS.
 
+.. _cabs-generic-items:
+
+Cab controls for generic items
+------------------------------
+
+OR supports the cabview controls for two generic two-state items. 
+The cabview controls aree called ``<ORTS_GENERIC_ITEM1>`` and 
+``<ORTS_GENERIC_ITEM2>``. Their state can be toggled also by respectively 
+clicking keys ``<Shift+.>`` and ``<Shift+,>``.
+
+Sound events are associated, that is::
+
+   240: GenericItem1On
+   241: GenericItem1Off
+   242: GenericItem2On
+   243: GenericItem2Off
+
+Animations within the .s file of the locomotive, either stopped/moving or 
+two-state can be associated to the item state. Linked stopped/moving (wiper type) 
+animations are named ``<ORTSITEM1CONTINUOUS>`` and ``<ORTSITEM2CONTINUOUS>``. 
+Linked two-state animations (doors type) are named ``<ORTSITEM1TWOSTATE>`` and
+``<ORTSITEM2TWOSTATE>``. 
+The default animation speed for stopped/moving type animations is 8 FPS. 
+It may be modified with following parameter in the .sd file::
+
+   ESD_CustomAnimationSpeed ( 8 )
+
+Examples of use are fan control, open/close of aerodynamic coverages of couplers 
+in high speed trains, menu pages switching.
+
 
 High-resolution Cab Backgrounds and Controls
 --------------------------------------------

Source/Documentation/Manual/sound.rst

@@ -391,6 +391,18 @@ Trigger       Function
 235           AirConditioningOff
 =========     =====================================
 
+Triggers from 240 to 243 associated to the two generic items 
+(see :ref:`here <cabs-generic-items>`) :
+
+=========     =====================================
+Trigger       Function
+=========     =====================================
+240           GenericItem1On
+241           GenericItem1Off
+242           GenericItem2On
+243           GenericItem2Off
+=========     =====================================
+
 Variable Triggers
 -----------------
 

Source/ORTS.Common/Input/UserCommand.cs

@@ -205,8 +205,10 @@ public enum UserCommand
         [GetString("Control ImmediateRefill")] ControlImmediateRefill,
         [GetString("Control Turntable Clockwise")] ControlTurntableClockwise,
         [GetString("Control Turntable Counterclockwise")] ControlTurntableCounterclockwise,
-        [GetString("Control Generic 1")] ControlGeneric1,
-        [GetString("Control Generic 2")] ControlGeneric2,
+        [GetString("Control Generic Item 1")] ControlGenericItem1,
+        [GetString("Control Generic Item 2")] ControlGenericItem2,
+        [GetString("Control TCS Generic 1")] ControlTCSGeneric1,
+        [GetString("Control TCS Generic 2")] ControlTCSGeneric2,
         [GetString("Control Cab Radio")] ControlCabRadio,
         [GetString("Control AI Fire On")] ControlAIFireOn,
         [GetString("Control AI Fire Off")] ControlAIFireOff,

Source/ORTS.Settings/InputSettings.cs

@@ -388,8 +388,10 @@ static void InitializeCommands(UserCommandInput[] Commands)
             Commands[(int)UserCommand.ControlForwards] = new UserCommandKeyInput(0x11);
             Commands[(int)UserCommand.ControlGearDown] = new UserCommandKeyInput(0x12, KeyModifiers.Shift);
             Commands[(int)UserCommand.ControlGearUp] = new UserCommandKeyInput(0x12);
-            Commands[(int)UserCommand.ControlGeneric1] = new UserCommandKeyInput(0x33, KeyModifiers.Control);
-            Commands[(int)UserCommand.ControlGeneric2] = new UserCommandKeyInput(0x34, KeyModifiers.Control);
+            Commands[(int)UserCommand.ControlGenericItem1] = new UserCommandKeyInput(0x33, KeyModifiers.Shift);
+            Commands[(int)UserCommand.ControlGenericItem2] = new UserCommandKeyInput(0x34, KeyModifiers.Shift);
+            Commands[(int)UserCommand.ControlTCSGeneric1] = new UserCommandKeyInput(0x33, KeyModifiers.Control);
+            Commands[(int)UserCommand.ControlTCSGeneric2] = new UserCommandKeyInput(0x34, KeyModifiers.Control);
             Commands[(int)UserCommand.ControlHandbrakeFull] = new UserCommandKeyInput(0x28, KeyModifiers.Shift);
             Commands[(int)UserCommand.ControlHandbrakeNone] = new UserCommandKeyInput(0x27, KeyModifiers.Shift);
             Commands[(int)UserCommand.ControlHeadlightDecrease] = new UserCommandKeyInput(0x23, KeyModifiers.Shift);

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -202,6 +202,10 @@ public enum CABViewControlTypes
         ORTS_ELECTRIC_TRAIN_SUPPLY_COMMAND_SWITCH,
         ORTS_ELECTRIC_TRAIN_SUPPLY_ON,
         ORTS_2DEXTERNALWIPERS,
+        ORTS_GENERIC_ITEM1,
+        ORTS_GENERIC_ITEM2,
+        ORTS_SCREEN_SELECT,
+        ORTS_STATIC_DISPLAY,
 
         // TCS Controls
         ORTS_TCS1,
@@ -390,6 +394,10 @@ public class CabViewControl
         public double OldValue;
         public string ACEFile = "";
 
+        public int Display;
+        public List<string> Screens;
+        public int CabViewpoint;
+
         public CABViewControlTypes ControlType = CABViewControlTypes.NONE;
         public CABViewControlStyles ControlStyle = CABViewControlStyles.NONE;
         public CABViewControlUnits Units = CABViewControlUnits.NONE;
@@ -509,6 +517,32 @@ protected virtual float ParseRotation(STFReader stf)
             stf.SkipRestOfBlock();
             return rotation;
         }
+
+        protected virtual void ParseDisplay(STFReader stf)
+        {
+            stf.MustMatch("(");
+            Display = stf.ReadInt(0);
+            stf.SkipRestOfBlock();
+        }
+
+        protected virtual void ParseScreen(STFReader stf)
+        {
+            stf.MustMatch("(");
+            var newScreen = stf.ReadString();
+            stf.SkipRestOfBlock();
+            if (Screens == null)
+                Screens = new List<string>();
+            Screens.Add(newScreen.ToLower());
+        }
+
+        protected virtual void ParseCabViewpoint(STFReader stf)
+        {
+            stf.MustMatch("(");
+            CabViewpoint = stf.ReadInt(0);
+            stf.SkipRestOfBlock();
+        }
+
+
     }
     #endregion
 
@@ -560,6 +594,9 @@ public CVCDial(STFReader stf, string basepath)
                     ToDegree = stf.ReadFloat(STFReader.UNITS.None, null);
                     stf.SkipRestOfBlock();
                 }),
+                new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
+                new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
+                new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
             });
         }
     }
@@ -645,7 +682,10 @@ public CVCGauge(STFReader stf, string basepath)
                             new STFReader.TokenProcessor("controlcolour", ()=>{ DecreaseColor = ParseControlColor(stf); }) });
                     }
                 }),
-                new STFReader.TokenProcessor("ortsangle", () =>{ Rotation = ParseRotation(stf); })
+                new STFReader.TokenProcessor("ortsangle", () =>{ Rotation = ParseRotation(stf); }),
+                new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
+                new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
+                new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
             });
         }
     }
@@ -768,7 +808,10 @@ public CVCDigital(STFReader stf, string basepath)
                     }
                 }),
                 new STFReader.TokenProcessor("ortsfont", ()=>{ParseFont(stf); }),
-                new STFReader.TokenProcessor("ortsangle", () => {Rotation = ParseRotation(stf); }),              
+                new STFReader.TokenProcessor("ortsangle", () => {Rotation = ParseRotation(stf); }),
+                new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
+                new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
+                new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
             });
         }
 
@@ -829,7 +872,10 @@ public CVCDigitalClock(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("accuracy", ()=>{ ParseAccuracy(stf); }), 
                 new STFReader.TokenProcessor("controlcolour", ()=>{ PositiveColor = ParseControlColor(stf); }),
                 new STFReader.TokenProcessor("ortsfont", ()=>{ParseFont(stf); }),
-                new STFReader.TokenProcessor("ortsangle", () => { Rotation = ParseRotation(stf); })
+                new STFReader.TokenProcessor("ortsangle", () => { Rotation = ParseRotation(stf); }),
+                new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
+                new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
+                new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
             });
         }
 
@@ -866,6 +912,14 @@ public class CVCDiscrete : CVCWithFrames
         private int numPositions;
         private bool canFill = true;
 
+        public struct NewScreenData
+        {
+            public string NewScreen;
+            public int NewScreenDisplay;
+
+        }
+        public List<NewScreenData> NewScreens;
+
         public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
         {
 //            try
@@ -999,6 +1053,10 @@ public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
                             _ValuesRead++;
                         }
                     }),
+                new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
+                new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
+                new STFReader.TokenProcessor("ortsnewscreenpage", () => {ParseNewScreen(stf); }),
+                new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
                 });
 
                 // If no ACE, just don't need any fixup
@@ -1188,6 +1246,18 @@ public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
 //                    throw new STFException(stf, "Problem with NumPositions/NumValues/NumFrames/ScaleRange");
 //            } // End of Need check the Values collection for validity
         } // End of Constructor
+
+        protected void ParseNewScreen(STFReader stf)
+        {
+            stf.MustMatch("(");
+            var newScreen = new NewScreenData();
+            newScreen.NewScreen = stf.ReadString().ToLower();
+            newScreen.NewScreenDisplay = stf.ReadInt(-1);
+            stf.SkipRestOfBlock();
+            if (NewScreens == null)
+                NewScreens = new List<NewScreenData>();
+            NewScreens.Add(newScreen); ;
+        }
     }
     #endregion
 
@@ -1228,6 +1298,9 @@ public CVCMultiStateDisplay(STFReader stf, string basepath)
                     for (int i = Values.Count; i < FramesCount; i++)
                         Values.Add(-10000);
                 }),
+                new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
+                new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
+                new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
             });
         }
         protected int ParseNumStyle(STFReader stf)
@@ -1275,6 +1348,9 @@ public CVCAnimatedDisplay(STFReader stf, string basepath)
                     for (int i = Values.Count; i < FramesCount; i++)
                         Values.Add(-10000);
                 }),
+                new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
+                new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
+                new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
             });
         }
         protected int ParseNumStyle(STFReader stf)
@@ -1307,6 +1383,9 @@ public CVCScreen(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("parameters", ()=>{ ParseCustomParameters(stf); }),
                 new STFReader.TokenProcessor("disablediflowvoltagepowersupplyoff", ()=>{ ParseDisabledIfLowVoltagePowerSupplyOff(stf); }),
                 new STFReader.TokenProcessor("disabledifcabpowersupplyoff", ()=>{ ParseDisabledIfCabPowerSupplyOff(stf); }),
+                new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
+                new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
+                new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
             });
         }
         protected void ParseCustomParameters(STFReader stf)

Source/Orts.Formats.Msts/ShapeDescriptorFile.cs

@@ -64,7 +64,8 @@ public SDShape(STFReader stf)
                             ESD_Bounding_Box = null;
                     }),
                     new STFReader.TokenProcessor("esd_ortssoundfilename", ()=>{ ESD_SoundFileName = stf.ReadStringBlock(null); }),
-                    new STFReader.TokenProcessor("esd_ortsbellanimationfps", ()=>{ ESD_BellAnimationFPS = stf.ReadFloatBlock(STFReader.UNITS.Frequency, null); }),
+                    new STFReader.TokenProcessor("esd_ortsbellanimationfps", ()=>{ ESD_CustomAnimationFPS = stf.ReadFloatBlock(STFReader.UNITS.Frequency, null); }),
+                    new STFReader.TokenProcessor("esd_ortscustomanimationfps", ()=>{ ESD_CustomAnimationFPS = stf.ReadFloatBlock(STFReader.UNITS.Frequency, null); }),
                 });
                 // TODO - some objects have no bounding box - ie JP2BillboardTree1.sd
                 //if (ESD_Bounding_Box == null) throw new STFException(stf, "Missing ESD_Bound_Box statement");
@@ -76,7 +77,7 @@ public SDShape(STFReader stf)
             public bool ESD_Snapable;
             public bool ESD_SubObj;
             public string ESD_SoundFileName = "";
-            public float ESD_BellAnimationFPS = 8;
+            public float ESD_CustomAnimationFPS = 8;
         }
 
         public class ESD_Bounding_Box

Source/Orts.Simulation/Common/Commands.cs

@@ -1999,4 +1999,47 @@ public override string ToString()
         }
     }
 
+    [Serializable()]
+    public sealed class ToggleGenericItem1Command : Command
+    {
+        public static MSTSLocomotive Receiver { get; set; }
+
+        public ToggleGenericItem1Command(CommandLog log)
+            : base(log)
+        {
+            Redo();
+        }
+
+        public override void Redo()
+        {
+            Receiver.GenericItem1Toggle();
+        }
+
+        public override string ToString()
+        {
+            return base.ToString();
+        }
+    }
+
+    [Serializable()]
+    public sealed class ToggleGenericItem2Command : Command
+    {
+        public static MSTSLocomotive Receiver { get; set; }
+
+        public ToggleGenericItem2Command(CommandLog log)
+            : base(log)
+        {
+            Redo();
+        }
+
+        public override void Redo()
+        {
+            Receiver.GenericItem2Toggle();
+        }
+
+        public override string ToString()
+        {
+            return base.ToString();
+        }
+    }
 }