Merge branch 'master' into Multiple-screens-official and resolve conflicts

Csantucci · Csantucci · commit 3be63540ac48 · 2021-12-14T16:45:12.000+01:00
diff --git a/Source/Documentation/Manual/cabs.rst b/Source/Documentation/Manual/cabs.rst
@@ -534,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
 --------------------------------------------
diff --git a/Source/Documentation/Manual/sound.rst b/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
 -----------------
 
diff --git a/Source/Documentation/Manual/timetable.rst b/Source/Documentation/Manual/timetable.rst
@@ -303,11 +303,9 @@ Special Rows
   will read that path. If not, it will read the 'normal' path, and will then 
   store this as binary for future use. Binary paths are stored in a subdirectory 
   named ``OpenRails`` which must be created in the Paths directory of the route.
-  
-  **Important:**
 
-    - If a path is edited, the binary version must be deleted manually, otherwise the program will still use this older version.
-    - If a route is edited, such that the .tdb might have been changed, all binary paths must be deleted.
+  Note: If a path or the route is edited, then the binary data will be out of date.
+  If so, it is deleted and re-created automatically when the user starts the route.
 
 - ``#consist`` row 
   
diff --git a/Source/ORTS.Common/Input/UserCommand.cs b/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,
diff --git a/Source/ORTS.Settings/InputSettings.cs b/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);
diff --git a/Source/Orts.Formats.Msts/CabViewFile.cs b/Source/Orts.Formats.Msts/CabViewFile.cs
@@ -202,6 +202,8 @@ 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,
 
diff --git a/Source/Orts.Formats.Msts/ShapeDescriptorFile.cs b/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
diff --git a/Source/Orts.Formats.Msts/TrackDatabaseFile.cs b/Source/Orts.Formats.Msts/TrackDatabaseFile.cs
@@ -39,6 +39,11 @@ public class TrackDatabaseFile
         /// </summary>
         public TrackDB TrackDB { get; set; }
 
+        /// <summary>
+        /// The .tdb file last modified time is stored for being able to validate derived files such as binary paths.
+        /// </summary>
+        public DateTime LastWriteTime { get; }
+
         /// <summary>
         /// Constructor from file
         /// </summary>
@@ -49,6 +54,8 @@ public TrackDatabaseFile(string filenamewithpath)
                 stf.ParseFile(new STFReader.TokenProcessor[] {
                     new STFReader.TokenProcessor("trackdb", ()=>{ TrackDB = new TrackDB(stf); }),
                 });
+
+            LastWriteTime = File.GetLastWriteTime(filenamewithpath);
         }
 
         /// <summary>
diff --git a/Source/Orts.Simulation/Common/Commands.cs b/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();
+        }
+    }
 }
diff --git a/Source/Orts.Simulation/Common/Events.cs b/Source/Orts.Simulation/Common/Events.cs
@@ -92,6 +92,10 @@ public enum Event
         GenericEvent6,
         GenericEvent7,
         GenericEvent8,
+        GenericItem1On,
+        GenericItem1Off,
+        GenericItem2On,
+        GenericItem2Off,
         HornOff,
         HornOn,
         LightSwitchToggle,
@@ -500,6 +504,11 @@ public static Event From(bool mstsBinEnabled, Source source, int eventID)
                         case 234: return Event.AirConditioningOn;
                         case 235: return Event.AirConditioningOff;
 
+                        case 240: return Event.GenericItem1On;
+                        case 241: return Event.GenericItem1Off;
+                        case 242: return Event.GenericItem2On;
+                        case 243: return Event.GenericItem2Off;
+
                         case 250: return Event.OverchargeBrakingOn;
                         case 251: return Event.OverchargeBrakingOff;
 
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs
@@ -1218,6 +1218,8 @@ public override void Save(BinaryWriter outf)
             outf.Write(IsWaterScoopDown);
             outf.Write(CurrentTrackSandBoxCapacityM3);
             outf.Write(SaveAdhesionFilter);
+            outf.Write(GenericItem1);
+            outf.Write(GenericItem2);
             outf.Write(RemoteControlGroup);
             outf.Write(DPUnitID);
 
@@ -1268,6 +1270,9 @@ public override void Restore(BinaryReader inf)
             SaveAdhesionFilter = inf.ReadSingle();
             
             AdhesionFilter.Reset(SaveAdhesionFilter);
+
+            GenericItem1 = inf.ReadBoolean();
+            GenericItem2 = inf.ReadBoolean();
             RemoteControlGroup = inf.ReadInt32();
             DPUnitID = inf.ReadInt32();
 
@@ -4236,6 +4241,18 @@ public void OdometerToggleDirection()
             Simulator.Confirmer.Confirm(CabControl.Odometer, OdometerCountingUp ? CabSetting.Increase : CabSetting.Decrease);
         }
 
+        public void GenericItem1Toggle()
+        {
+            GenericItem1 = !GenericItem1;
+            SignalEvent(GenericItem1? Event.GenericItem1On : Event.GenericItem1Off); // hook for sound trigger
+        }
+
+        public void GenericItem2Toggle()
+        {
+            GenericItem2 = !GenericItem2;
+            SignalEvent(GenericItem2 ? Event.GenericItem2On : Event.GenericItem2Off); // hook for sound trigger
+        }
+
         public override bool GetCabFlipped()
         {
             return UsingRearCab;
@@ -5119,6 +5136,16 @@ public virtual float GetDataOf(CabViewControl cvc)
                         seconds += 60;
                     data = seconds;
                     break;
+                case CABViewControlTypes.ORTS_GENERIC_ITEM1:
+                    {
+                        data = GenericItem1 ? 1 : 0;
+                        break;
+                    }
+                case CABViewControlTypes.ORTS_GENERIC_ITEM2:
+                    {
+                        data = GenericItem2 ? 1 : 0;
+                        break;
+                    }
 
                 // Train Control System controls
                 case CABViewControlTypes.ORTS_TCS1:
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs
@@ -81,6 +81,10 @@ public class MSTSWagon : TrainCar
         public bool IsDavisFriction = true; // Default to new Davis type friction
         public bool IsBelowMergeSpeed = true; // set indicator for low speed operation as per given speed
 
+
+        public bool GenericItem1;
+        public bool GenericItem2;
+
         Interpolator BrakeShoeFrictionFactor;  // Factor of friction for wagon brake shoes
         const float WaterLBpUKG = 10.0f;    // lbs of water in 1 gal (uk)
         float TempMassDiffRatio;
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/TrainCar.cs b/Source/Orts.Simulation/Simulation/RollingStocks/TrainCar.cs
@@ -509,7 +509,7 @@ public int GearboxGearIndex
             }
         }
 
-        public float LocalDynamicBrakePercent;
+        public float LocalDynamicBrakePercent = -1;
         public float DynamicBrakePercent
         {
             get
@@ -536,6 +536,8 @@ public float DynamicBrakePercent
                     Train.MUDynamicBrakePercent = value;
                 else
                     LocalDynamicBrakePercent = value;
+                if (Train != null && this == Train.LeadLocomotive)
+                    LocalDynamicBrakePercent = value;
             }
         }
         public Direction Direction
diff --git a/Source/Orts.Simulation/Simulation/Timetables/ProcessTimetable.cs b/Source/Orts.Simulation/Simulation/Timetables/ProcessTimetable.cs
@@ -1160,7 +1160,7 @@ public bool PreProcessRoutes(CancellationToken cancellation)
             {
                 // read route
                 bool pathValid = true;
-                AIPath newPath = LoadPath(thisRoute, out pathValid);
+                LoadPath(thisRoute, out pathValid);
                 if (!pathValid) allPathsLoaded = false;
                 if (cancellation.IsCancellationRequested)
                     return (false);
@@ -1187,23 +1187,23 @@ public AIPath LoadPath(string pathstring, out bool validPath)
             if (String.IsNullOrEmpty(pathExtension))
                 formedpathFilefull = Path.ChangeExtension(formedpathFilefull, "pat");
 
-            // try to load binary path if required
-            bool binaryloaded = false;
-            AIPath outPath = null;
-
-            if (Paths.ContainsKey(formedpathFilefull))
-            {
-                outPath = new AIPath(Paths[formedpathFilefull]);
-            }
-            else
+            if (!Paths.TryGetValue(formedpathFilefull, out var outPath))
             {
+                // try to load binary path if required
+                bool binaryloaded = false;
                 string formedpathFilefullBinary = Path.Combine(Path.GetDirectoryName(formedpathFilefull), "OpenRails");
                 formedpathFilefullBinary = Path.Combine(formedpathFilefullBinary, Path.GetFileNameWithoutExtension(formedpathFilefull));
                 formedpathFilefullBinary = Path.ChangeExtension(formedpathFilefullBinary, "or-binpat");
 
-                if (BinaryPaths)
+                if (BinaryPaths && File.Exists(formedpathFilefullBinary))
                 {
-                    if (File.Exists(formedpathFilefullBinary))
+                    var binaryLastWriteTime = File.GetLastWriteTime(formedpathFilefullBinary);
+                    if (binaryLastWriteTime < simulator.TDB.LastWriteTime ||
+                        File.Exists(formedpathFilefull) && binaryLastWriteTime < File.GetLastWriteTime(formedpathFilefull))
+                    {
+                        File.Delete(formedpathFilefullBinary);
+                    }
+                    else
                     {
                         try
                         {
@@ -1213,7 +1213,7 @@ public AIPath LoadPath(string pathstring, out bool validPath)
 
                             if (outPath.Nodes != null)
                             {
-                                Paths.Add(formedpathFilefull, new AIPath(outPath));
+                                Paths.Add(formedpathFilefull, outPath);
                                 binaryloaded = true;
                             }
                         }
@@ -1235,7 +1235,7 @@ public AIPath LoadPath(string pathstring, out bool validPath)
                         {
                             try
                             {
-                                Paths.Add(formedpathFilefull, new AIPath(outPath));
+                                Paths.Add(formedpathFilefull, outPath);
                             }
                             catch (Exception e)
                             {
diff --git a/Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs b/Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs
diff --git a/Source/RunActivity/Viewer3D/RollingStock/MSTSWagonViewer.cs b/Source/RunActivity/Viewer3D/RollingStock/MSTSWagonViewer.cs
diff --git a/Source/RunActivity/Viewer3D/Shapes.cs b/Source/RunActivity/Viewer3D/Shapes.cs
diff --git a/Source/RunActivity/Viewer3D/Viewer.cs b/Source/RunActivity/Viewer3D/Viewer.cs
