Skip to content

Commit

Permalink
Merge branch 'blueprint/TrainCarOperations-ui-window' of https://gith…
Browse files Browse the repository at this point in the history
…ub.com/mbm-OR/openrails into blueprint/TrainCarOperations-ui-window
  • Loading branch information
mbm-OR committed Nov 30, 2023
2 parents 840c451 + 1734b59 commit c5cdbd3
Show file tree
Hide file tree
Showing 12 changed files with 104 additions and 9 deletions.
1 change: 1 addition & 0 deletions Source/Documentation/Manual/_static/readme.txt
@@ -0,0 +1 @@
this empty directory supresses a warning during sphinx build
97 changes: 93 additions & 4 deletions Source/Documentation/Manual/driving.rst
Expand Up @@ -38,7 +38,7 @@ can select different views using the keyboard, as described in
:ref:`Changing the View <driving-changing-view>`.

Cab Letter-Boxing
----------------
-----------------

OR manages not only cab interiors using 2D images in a MSTS-compatible
way, but also supports 3D models. Most 2D cab images follow MSTS practice,
Expand Down Expand Up @@ -576,6 +576,97 @@ appears on the car's display line until the air pressure has fallen to zero.
More information about manipulating the brakes during coupling and
uncoupling can also be found :ref:`here <driving-hud-brake>`.

.. _train-operations-monitor:

Ctrl-Alt-F9 Train Operations Monitor
------------------------------------

This Open Rails Train Operations window has a vertical view of the entire train:

.. image:: images/TrainCarOperations-01.png
:align: center
:scale: 100%

|
This window shows the whole train in vertical mode. Any car can be selected by clicking on the Car ID.
Two arrows will then appear pointing to the selected car.

By clicking on the selected CarId the "Train Operations Viewer" window will be displayed:

.. image:: images/TrainOperationsViewer-02.png
:align: center
:scale: 100%

|
From the "Train Operations Viewer" window, we can set all the available systems, as in the “Car Operation menu”:

- FrontBrakeHose
- FrontAngleCock
- CouplerFront
- CouplerRear
- RearAngleCock
- RearBrakeHose
- HandBrake
- BleedOffValve
- ToggleElectricTrainSupplyCable
- ToggleMU
- TogglePower
- ToggleBatterySwitch

This is where all the symbols are placed:

.. image:: images/TrainOperationsViewer.png
:align: center
:scale: 100%

|
The red cross on the handbrake symbol (or another), indicates that it is not available.

Any changes made in this window will also appear in the "Train Car Operations" window:

.. image:: images/TrainOperationsViewer-03.png
:align: center
:scale: 100%

|
After a change in the braking system that keeps the train stopped, the CarID changes to a cyan colour.
In this way, it is easy for the user, to find out which car is stopping the train.

A click on the right arrow hides all non-system brake symbols, inside the "Train Car Operations" window:

.. image:: images/TrainCarOperations-04.png
:align: center
:scale: 100%

|
To make the text bold, click the left arrow:

.. image:: images/TrainCarOperations-05.png
:align: center
:scale: 100%

|
While the "Train Operations Viewer" window is visible, we can modify the "Train Car Operations" window,
but if we open the "Train Operations" window <F9> and click on any CarID, the "Car Operation Menu" will
appear and it will point to the previously selected CarID in the "Train Operations Viewer" window.
The "Car Operations Menu" is updated from the "Train Operations Viewer" window.
A click on the CarID in the “Train Operations Viewer” will close the window.

If the train is very long and not all the cars are displayed in the "Train Car Operations" window, we can scroll by clicking on the white down arrow (vertical scroll bar) at the bottom right.
Once the required car has been selected, it will remain visible on the last row:

.. image:: images/TrainCarOperations-06.png
:align: center
:scale: 100%

|
.. _driving-activity:

F10 Activity Monitor
Expand Down Expand Up @@ -637,7 +728,7 @@ within the cabview, see :ref:`here <cabs-odometer>`.


Activity Evaluation
------------------
-------------------

``Description``
'''''''''''''''
Expand Down Expand Up @@ -710,8 +801,6 @@ This report is made up of several sections.
:scale: 80%
:align: center

.. raw:: latex

The report file OpenRailsEvaluation.txt is saved alongside the log file OpenRailsLog.txt and
the default location for this is the Windows Desktop.

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions Source/Documentation/Manual/software-platform.rst
Expand Up @@ -154,6 +154,11 @@ If you choose to develop your own pages, please consider sharing them with the O
.. image:: images/switch-panel.png

- The Train Car Operations page has the same functionality as the :ref:`Ctrl-Alt-F9 Train Operations Monitor <train-operations-monitor>`.
Advantage of having this windows as a web page is that it can be shown outside the Open Rails main window.
Even on another display like for instance a tablet. It has more or less the same functionality, more details
to be found :ref:`here <train-operations-monitor>`.

.. _web-server-api:

Application Programming Interfaces (APIs)
Expand Down
4 changes: 2 additions & 2 deletions Source/Documentation/Manual/start.rst
Expand Up @@ -46,7 +46,7 @@ When a new release of OR is available and your computer is online, a link
the release number of the newest release that matches your selected level
of update. Various level of updates called Update Channels are available.
You may choose the desired level in the ``Options-Update`` window, described
:ref:`below <options-updater>`.
:ref:`below <options-updater-options>`.

When you click on the update link OR will download and install the new
release. In this way your version of Open Rails is always up to date.
Expand Down Expand Up @@ -126,7 +126,7 @@ If you instead select a specific activity, you won't have to perform any
further selections.

Activity Evaluation
''''''''''''''''''
'''''''''''''''''''

During the activity session, data about performance is stored and may be viewed as the activity progresses.
At the end of the activity a report file is generated which provides a summary of
Expand Down
Expand Up @@ -1020,15 +1020,15 @@ private void fillStatusPower(int carPosition)
filename = "TrainOperationsPowerChanging32.png";
break;
case CircuitBreakerState.Open:
filename = "TrainOperationsPowerOn32.png";
filename = "TrainOperationsPowerOff32.png";
break;
case CircuitBreakerState.Closed:
filename = "TrainOperationsPowerOff32.png";
filename = "TrainOperationsPowerOn32.png";
break;
}
}

if (trainCar is MSTSElectricLocomotive)
if (trainCar is MSTSDieselLocomotive)
{
switch ((trainCar as MSTSDieselLocomotive).DieselEngines.State)
{
Expand Down

0 comments on commit c5cdbd3

Please sign in to comment.