Merge remote-tracking branch 'upstream/master'

Author: cjakeman

Source/ContentChecker/TrackFileLoader.cs

@@ -131,7 +131,7 @@ void AddAllActivities()
                 List<string> timetableFiles = new List<string>();
                 timetableFiles.AddRange(Directory.GetFiles(activityPathOr, "*.timetable_or"));
                 timetableFiles.AddRange(Directory.GetFiles(activityPathOr, "*.timetable-or"));
-                timetableFiles.AddRange(Directory.GetFiles(activityPathOr, "*.timetablelist-or"));
+                timetableFiles.AddRange(Directory.GetFiles(activityPathOr, "*.timetablelist_or"));
                 timetableFiles.AddRange(Directory.GetFiles(activityPathOr, "*.timetablelist-or"));
                 foreach (string timetableFile in timetableFiles)
                 {

Source/Contrib/ContentManager/ContentMSTS.cs

@@ -124,7 +124,7 @@ public override IEnumerable<Content> Get(ContentType type)
 
                 var pathOR = Path.Combine(PathName, @"Activities\OpenRails");
                 if (Directory.Exists(pathOR))
-                    foreach (var item in Directory.GetFiles(pathOR, "*.timetable_or"))
+                    foreach (var item in Enumerable.Concat(Directory.GetFiles(pathOR, "*.timetable_or"), Directory.GetFiles(pathOR, "*.timetable-or")))
                         yield return new ContentORTimetableActivity(this, Path.Combine(pathOR, item));
             }
         }

Source/Contrib/ContentManager/Models/Activity.cs

@@ -50,7 +50,8 @@ public Activity(Content content)
                 else
                     Services = new string[0];
             }
-            else if (System.IO.Path.GetExtension(content.PathName).Equals(".timetable_or", StringComparison.OrdinalIgnoreCase))
+            else if (System.IO.Path.GetExtension(content.PathName).Equals(".timetable_or", StringComparison.OrdinalIgnoreCase)
+                || System.IO.Path.GetExtension(content.PathName).Equals(".timetable-or", StringComparison.OrdinalIgnoreCase))
             {
                 // TODO: Make common timetable parser.
                 var file = new TimetableReader(content.PathName);

Source/Contrib/ContentManager/Models/Service.cs

@@ -69,7 +69,8 @@ public Service(Content content)
                     Stops = trafficService.TrafficDetails.Zip(activityService.ServiceList, (tt, stop) => new Stop(stop.PlatformStartID, stop.DistanceDownPath, MSTSTimeToDateTime(tt.ArrivalTime), MSTSTimeToDateTime(tt.DepartTime)));
                 }
             }
-            else if (System.IO.Path.GetExtension(content.PathName).Equals(".timetable_or", StringComparison.OrdinalIgnoreCase))
+            else if (System.IO.Path.GetExtension(content.PathName).Equals(".timetable_or", StringComparison.OrdinalIgnoreCase)
+                || System.IO.Path.GetExtension(content.PathName).Equals(".timetable-or", StringComparison.OrdinalIgnoreCase))
             {
                 // TODO: Make common timetable parser.
                 var file = new TimetableReader(content.PathName);

Source/Documentation/Manual/.devcontainer/Dockerfile

@@ -0,0 +1,2 @@
+FROM sphinxdoc/sphinx-latexpdf
+RUN pip install --no-cache-dir sphinx-rtd-theme

Source/Documentation/Manual/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+    "build": {
+        "dockerfile": "Dockerfile"
+    },
+    "workspaceMount": "source=${localWorkspaceFolder},target=/docs,type=bind",
+    "workspaceFolder": "/docs",
+    "remoteUser": "vscode",
+    "features": {
+        "common": {
+            "username": "automatic",
+            "uid": "automatic",
+            "gid": "automatic",
+            "installZsh": true,
+            "installOhMyZsh": true,
+            "upgradePackages": true,
+            "nonFreePackages": false
+        }
+    },
+    "extensions": [
+        "TatsuyaNakamori.resttext"
+    ]
+}

Source/Documentation/Manual/.vscode/tasks.json

@@ -0,0 +1,32 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "shell",
+			"command": "make",
+			"args": ["html"],
+			"label": "Build: html",
+			"problemMatcher": [],
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		},
+		{
+			"type": "shell",
+			"command": "make",
+			"args": ["latexpdf"],
+			"label": "Build: latex",
+			"problemMatcher": [],
+			"group": "build"
+		},
+		{
+			"type": "shell",
+			"command": "make",
+			"args": ["clean"],
+			"label": "Build: Make Clean",
+			"problemMatcher": [],
+			"group": "build"
+		}
+	]
+}

Source/Documentation/Manual/cabs.rst

@@ -403,6 +403,67 @@ Here is an example of use of the odometer control blocks within a .cvf file::
     Units ( FEET )
   )
 
+.. _cabs-distributed-power:
+
+Distributed Power
+-----------------
+
+The principles of Distributed Power are described :ref:`here <distributed-power>` .
+
+Distributed Power data can be displayed using control ORTS_DISTRIBUTED_POWER. Here 
+an example of use::
+
+	ScreenDisplay (
+      Type ( ORTS_DISTRIBUTED_POWER SCREEN_DISPLAY )
+      Position (  164.4 286.5 136 52 )
+		Parameters (
+         FullTable True
+         LoadUnits AMPS
+		)
+      Units ( KM_PER_HOUR )
+		ORTSDisplay ( 1 )
+		ORTSScreenPage ( "2300-0" )
+   )  
+
+Here below an example of the output of the above control.
+
+.. image:: images/cabs-distributed-power.png
+
+When parameter FullTable is set to False, only the first 6 lines 
+are displayed.
+Optional parameter LoadUnits defines which is the UoM used for the 
+Load field. Default is AMPS in a metric environment and KILO_LBS in 
+the other cases. Selectable LoadUnits are AMPS, NEWTONS, KILO_NEWTONS, 
+LBS and KILO_KBS.
+
+The screen display can be rotated adding parameter 
+ORTSAngle ( number ) in the ScreenDisplay block. The angle is in degrees.
+
+For every keyboard command related to Distributed Power, a cabview control 
+is also available. Here's a list of the cabview controls::
+
+   - ORTS_DP_MOVE_TO_FRONT
+   - ORTS_DP_MOVE_TO_BACK
+   - ORTS_DP_IDLE
+   - ORTS_DP_TRACTION
+   - ORTS_DP_BRAKE
+   - ORTS_DP_MORE
+   - ORTS_DP_LESS
+
+Here an example of use of one of the controls::
+
+   TwoState (
+		Type ( ORTS_DP_MOVE_TO_FRONT TWO_STATE )
+		Position ( 163.2 378.4 13.75 10 )
+		Graphic ( "..\\..\\Common.Cab\\ES44v3\\softkey1trans.ace" )
+		NumFrames ( 2 2 1 )
+		Style ( WHILE_PRESSED )
+		MouseControl ( 1 )
+		ORTSDisplay ( 1 )
+		ORTSScreenPage ( "2300-0" )
+	)
+
+
 Animated 2D Wipers
 ------------------
 

Source/Documentation/Manual/driving.rst

@@ -2226,35 +2226,52 @@ This applies to both Timetable Mode and Activity Mode.
 Extended HUD for Debug Information
 ----------------------------------
 
-The last extended HUD display shows Debug information.
+The last extended HUD display shows Debug information containing:
+
+- Logging enabled: :ref:`logging status <driving-logfile>`
+- Build: date and time Open Rails was compiled
+- CPU: processor utilization by Open Rails
+- GPU: frame rate, frame time percentiles and graphics feature level
+- Memory: number of core memory objects loaded (textures, materials, shapes, and tiles) plus garbage collection statistics
+- CPU Memory:
+
+  - Private: virtual memory allocated just for Open Rails (not shared with other applications)
+  - Working set: physical memory in use by Open Rails (including any shared with other applications)
+  - Private working set: physical memory in use just for Open Rails
+  - Managed: virtual memory allocated by the .NET runtime (CLR)
+  - Virtual: virtual memory allocated for any purpose (private + shared + others)
+
+- GPU Memory: 
+
+  - Committed: all graphics memory allocated for Open Rails
+  - Dedicated: physical graphics card memory in use by Open Rails
+  - Shared: system memory shared with the graphics card in use by Open Rails
+
+- Adapter: name and dedicated physical memory of graphics card
+- Shadow maps: distance and size of each shadow map level (and texture size)
+- Shadow primitives: total primitives (rendered items) and breakdown by shadow map level
+- Render primitives: total primitives (rendered items) and breakdown by rendering sequence (``RenderPrimitiveSequence`` in the code)
+- Render/Updater/Loader/Sound process: percentage of time each process is active and waiting
+- Camera: tile X, tile Z, X, Y, Z, altitude, LOD bias, effective viewing distance, effective distant mountain viewing distance
 
-The first line (``Logging enabled``) refers to logging as described in 
-paragraphs 6.6 and 6.7.
+.. image:: images/driving-hud-debug.png
 
-A wide variety of parameters is shown, from frame wait and render speeds 
-in milliseconds, to number of primitives, Process Thread resource 
-utilization and number of Logical CPUs from the system's bios. They are 
-very useful in case of OR stuttering, to find out where the bottleneck is.
+The primary measurements for comparing and analysing performance are the first column of values (some lines are skipped), so for the image above we have:
 
-.. index::
-   single: tile
+- CPU: 10% - *very low (warning at 75%)*
+- GPU: 58 FPS - *good (warning at <55 FPS with 60 Hz vertical sync)*
+- CPU Memory: 211 MB private - *very low (~3% of 8 GB)*
+- GPU Memory: 493 MB committed - *low (~24% of 2 GB)*
+- Highest process (Render): 47% - *moderate (warning at 75%)*
 
-The values in the ``Camera`` line refer to the two tile coordinates and to 
-the three coordinates within the tile.
+Also shown are the following graphs of:
 
-.. image:: images/driving-hud-debug.png
-    :align: center
-    :scale: 80%
+- Memory: working set
+- GCs: garbage collections
+- Frame time: how long each frame takes to render
+- Render/Updater/Loader/Sound process: same as textual display above
 
 .. image:: images/driving-hud-debug-graphs.png
-    :align: center
-    :scale: 80%
-
-At the bottom of the picture, some moving graphs are displayed that show 
-the actual load of the computer.
-
-Referring to memory use, about at least 400 MB must remain free to 
-avoid out-of-memory exceptions
 
 Viewing Interactive Track Items
 -------------------------------