Skip to content

Commit 4629736

Browse files
committed
Doc changes
1 parent b54024b commit 4629736

File tree

1 file changed

+47
-65
lines changed

1 file changed

+47
-65
lines changed

Source/Documentation/Manual/cabs.rst

+47-65
Original file line numberDiff line numberDiff line change
@@ -20,46 +20,65 @@ next paragraphs.
2020
ETCS circular speed gauge
2121
-------------------------
2222

23-
You can add to the cabview a
24-
circular speed gauge accordingly to the European standard train control
25-
system ETCS.
23+
A circular speed gauge accordingly to the standard European Train Control System
24+
(ETCS) can be added to the cabview. The information displayed in the Driver
25+
Machine Interface (DMI) is controlled via the TCS script. For more details,
26+
see :ref:`C# engine scripting - Train Control System <features-scripting-tcs>`.
27+
2628

2729
.. image:: images/options-etcs.png
2830
:scale: 60 %
2931
:align: center
3032

3133

32-
.. admonition:: For content developers
34+
The gauge is added by the insertion of a block like the following
35+
into the .cvf file::
3336

34-
The gauge is added by the insertion of a block like the following
35-
into the .cvf file::
36-
37-
Digital (
38-
Type ( SPEEDOMETER DIGITAL )
39-
Style ( NEEDLE )
40-
Position ( 160 255 56 56 )
41-
ScaleRange ( 0 250 )
42-
Units ( KM_PER_HOUR )
43-
)
37+
Digital (
38+
Type ( SPEEDOMETER DIGITAL )
39+
Style ( NEEDLE )
40+
Position ( 160 255 56 56 )
41+
ScaleRange ( 0 250 )
42+
Units ( KM_PER_HOUR )
43+
)
4444

4545
It is also possible to display the full ETCS display using the following block
4646
instead::
4747

48-
ScreenDisplay (
49-
Type ( ORTS_ETCS SCREEN_DISPLAY )
50-
Position ( 280 272 320 240 )
51-
Units ( KM_PER_HOUR )
52-
Parameters (
53-
Mode FullSize
54-
)
55-
)
56-
57-
The following DMI size variants are available: FullSize (displays the whole DMI), SpeedArea
58-
(displays only the left part with information about distance and speed) and PlanningArea
59-
(displays only the planning area and navigation buttons).
48+
ScreenDisplay (
49+
Type ( ORTS_ETCS SCREEN_DISPLAY )
50+
Graphic ( statictexture.ace ) Comment( 3D cab only, mandatory there )
51+
Position ( 280 272 320 240 ) Comment( 2D cab only )
52+
Units ( KM_PER_HOUR )
53+
Parameters (
54+
Mode FullSize
55+
MaxSpeed 180
56+
DisplayUnits 0
57+
)
58+
)
6059

61-
The information displayed in the DMI is controlled via the TCS script. For more details,
62-
see :ref:`C# engine scripting - Train Control System <features-scripting-tcs>`.
60+
The following commonly used ``MaxSpeed`` or ``ScaleRange`` values can be set
61+
* 140, 150, 180, 240, 250, 260, 280, 400 for ``KM_PER_HOUR`` unit
62+
* 87, 111, 155, 248 for ``MILES_PER_HOUR`` unit
63+
The default value is 400 with KM_PER_HOUR unit.
64+
65+
The following DMI size variants are available:
66+
``FullSize`` displays the whole DMI,
67+
``SpeedArea`` displays only the left part with information about distance and speed,
68+
``PlanningArea`` displays only the right side planning area and navigation buttons.
69+
The default value is FullSize
70+
71+
Use the ``MaxVisibleSpeed`` to set the highest speed displayed as a number,
72+
if literal numbering is undesirable above this number on the circular speed gauge.
73+
The default value is the MaxSpeed rounded to the highest tens below.
74+
75+
Use the ``DisplayUnits`` parameter to suppress diplaying the speed unit at the
76+
bottom of the circular speed gauge. The default is 1, displaying the units.
77+
78+
Use the ``Graphic`` parameter in 3D cabs to designate the static texture inside
79+
the .s file that will be replaced at runtime with the dynamic picture of the
80+
display. This parameter is mandatory. If omitted, or the named texture cannot
81+
be found in the model, no display will be shown.
6382

6483
.. _cabs-battery-switch:
6584

@@ -1364,43 +1383,6 @@ Customizations for such file are possible following these rules:
13641383
Except for the first column, fields
13651384
in the 3D distributed power display are always with center alignment.
13661385

1367-
ETCS circular speed gauge and the Driver Machine Interface
1368-
----------------------------------------------------------
1369-
1370-
It is possible to show the ETCS display using the following block::
1371-
1372-
ScreenDisplay (
1373-
Type ( ORTS_ETCS SCREEN_DISPLAY )
1374-
Graphic ( statictexture.ace )
1375-
Units ( KM_PER_HOUR )
1376-
Parameters (
1377-
Mode FullSize
1378-
MaxSpeed 180
1379-
DisplayUnits 0
1380-
)
1381-
)
1382-
1383-
The following DMI size variants are available: ``FullSize`` displays the whole DMI,
1384-
``SpeedArea`` displays only the left part with information about distance and speed
1385-
and ``PlanningArea`` displays only the right side planning area and navigation buttons.
1386-
The default value is FullSize
1387-
1388-
The following commonly used ``MaxSpeed`` values can be set
1389-
* 140, 150, 180, 240, 250, 260, 280, 400 for ``KM_PER_HOUR`` unit
1390-
* 87, 111, 155, 248 for ``MILES_PER_HOUR`` unit
1391-
The default value is 400 with KM_PER_HOUR unit.
1392-
1393-
Use the ``MaxVisibleSpeed`` to set the highest speed displayed as a number,
1394-
if literal numbering is undesirable above this number on the circular speed gauge.
1395-
The default value is the MaxSpeed rounded to the highest tens below.
1396-
1397-
Use the ``DisplayUnits`` parameter to suppress diplaying the speed unit at the
1398-
bottom of the circular speed gauge. The default is 1.
1399-
1400-
Use the ``Graphic`` parameter to designate the static texture inside the .s file
1401-
that will be replaced at runtime with the dynamic picture of the display. This
1402-
parameter is mandatory, if omitted, no display will be shown.
1403-
14041386
Alignment for digital controls
14051387
------------------------------
14061388

0 commit comments

Comments
 (0)