Skip to content

Commit 5e73592

Browse files
committed
Automatic merge of T1.5.1-905-gaf8fb30c5 and 13 pull requests
- Pull request #570 at 3539862: Experimental glTF 2.0 support with PBR lighting - Pull request #839 at d00beb9: First phase of https://blueprints.launchpad.net/or/+spec/additional-cruise-control-parameters - Pull request #876 at f92de76: docs: add source for documents previously on website to source Documentation folder - Pull request #882 at 9c456aa: Blueprint/train car operations UI window - Pull request #885 at 8f94333: feat: Add notifications to Menu - Pull request #886 at 6c0785b: Scene viewer extension to TrackViewer - Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH - Pull request #896 at 5866028: First implementation of https://blueprints.launchpad.net/or/+spec/specific-sounds-for-ai-trains - Pull request #903 at 9bead33: Downloading route content (Github, zip) - Pull request #911 at 6834af0: docs: Add refactoring as a special type of PR - Pull request #916 at 64f4876: Distributed Power Air Brake Synchronization - Pull request #919 at 7aafe02: Added mouse wheel support for controls which can be moved by pressing t… - Pull request #920 at a94e403: Update RailDriver in Manual
15 parents 657d222 + af8fb30 + 3539862 + d00beb9 + f92de76 + 9c456aa + 8f94333 + 6c0785b + 1f5ba4c + 5866028 + 9bead33 + 6834af0 + 64f4876 + 7aafe02 + a94e403 commit 5e73592

File tree

13 files changed

+641
-572
lines changed

13 files changed

+641
-572
lines changed

Source/Documentation/Manual/cabs.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -684,14 +684,16 @@ Air Flow Meter
684684

685685
.. index::
686686
single: ORTS_AIR_FLOW_METER
687+
single: ORTS_TRAIN_AIR_FLOW_METER
687688

688689
This cabview control is used on some locomotives, particularly in North America, to show the
689690
volumetric flow rate of air moving from the main res to the brake pipe during release/recharge.
690691
Such an indication can be used to determine when brake pipe charging is complete,
691692
measure the amount of brake pipe leakage, and so on.
692693
The control will only function on locomotives with air brakes.
693694

694-
Here is an example implementation of ORTS_AIR_FLOW_METER as an analog dial::
695+
Here is an example implementation of ORTS_AIR_FLOW_METER as an analog dial (display types other
696+
than analog dials can be used)::
695697

696698

697699
Dial (
@@ -706,8 +708,10 @@ Here is an example implementation of ORTS_AIR_FLOW_METER as an analog dial::
706708
DirIncrease ( 0 )
707709
)
708710

709-
Applicable user-defined units are CUBIC_FT_MIN, LITERS_S, LITERS_MIN, and CUBIC_M_S. Cubic meters per
710-
second will be used if no units are specified.
711+
Alternately, a control type of ORTS_TRAIN_AIR_FLOW_METER can be used to display the total
712+
air flow rate of all locomotives, useful for distributed power where multiple locomotives can
713+
charge the brake pipe simultaneously. Applicable user-defined units are CUBIC_FT_MIN, LITERS_S,
714+
LITERS_MIN, and CUBIC_M_S. Cubic meters per second will be used if no units are specified.
711715

712716

713717
Animated 2D Wipers

Source/Documentation/Manual/physics.rst

Lines changed: 52 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -2350,6 +2350,52 @@ The actual set value of traction or dynamic brake of *async* group is shown in
23502350
lines *Throttle* and *Dynamic Brake*, respectively, in brackets, e.g.:
23512351
Throttle: 0% (50%).
23522352

2353+
In addition to applying power and dynamic brake, remote units can also manage the
2354+
train brake, independent brake, and emergency brake in sync with the lead locomotive.
2355+
This can dramatically speed up brake application and release on long trains, which has
2356+
allowed trains to increase in length substantially without major decreases in brake
2357+
performance. Only one locomotive in each group, the 'lead' DP unit, will have brakes
2358+
cut-in. Usually this is the same locomotive recieving throttle data from the lead
2359+
locomotive. In Open Rails, these locomotives are designated automatically. To determine
2360+
which units are the 'lead' in each group, check the ID row on the DPU Info window.
2361+
2362+
As described earlier, operation in *sync* mode or *async* mode has no effect on air
2363+
brake behavior. In reality, additional remote modes such as *set-out*, *bv out*,
2364+
and *isolate* would disable air brakes on remote units, but these modes are not
2365+
present for simplicity.
2366+
2367+
.. index::
2368+
single: ORTSDPBrakeSynchronization
2369+
2370+
By default, Open Rails will treat remote groups as manned helpers who typically
2371+
would not assist in train brake operations, so only independent brakes will synchronize.
2372+
To enable train brake synchronization, the token ``engine(ORTSDPBrakeSynchronization(``
2373+
should be used. The valid settings for ``ORTSDPBrakeSynchronization`` are as follows:
2374+
2375+
- ``"Apply"``: DP units will reduce the brake pipe pressure locally to match the
2376+
equalizing reservoir pressure of the controlling locomotive. (The controlling
2377+
locomotive must also have the ``"Apply"`` setting.)
2378+
- ``"Release"``: DP units will increase the brake pipe pressure locally to match
2379+
the equalizing reservoir pressure of the controlling locomotive. (The controlling
2380+
locomotive must also have the ``"Release"`` setting.)
2381+
- ``"Emergency"``: DP units will vent the brake pipe to 0 if an emergency application
2382+
is triggered by the controlling locomotive. (The controlling locomotive must also
2383+
have the ``"Emergency"`` setting.)
2384+
- ``"Independent"``: DP units will match the brake cylinder pressure of the
2385+
controlling locomotive, and will automatically bail-off automatic brake
2386+
applications if needed. (The controlling locomotive must also have the
2387+
``"Independent"`` setting.)
2388+
- NOTE: Although ``"Independent"`` is enabled by default,
2389+
if ``ORTSDPBrakeSynchronization`` is present in the .eng
2390+
file but ``"Independent"`` is not specified as an option,
2391+
independent brakes will NOT be synchronized.
2392+
2393+
All settings can be combined as needed, simply place a comma between each setting
2394+
in the string: ``ORTSDPBrakeSynchronization("Apply, Release, Emergency, Independent")``
2395+
will simulate the configuration of most modern locomotives. Unlike other distributed power
2396+
features, brake synchronization can be applied to any locomotive type to simulate a wide
2397+
variety of braking systems.
2398+
23532399
Distributed power info and commands can also be displayed and operated through
23542400
cabview controls, as explained :ref:`here <cabs-distributed-power>`
23552401

@@ -2439,6 +2485,9 @@ be about 1 minute for every 12 cars. If the *Brake Pipe Charging Rate*
24392485
will be disabled and will also disable some but not all of the other new
24402486
brake features.
24412487

2488+
Brake system charging time depends on the train length as it should, but
2489+
at the moment there is no modeling of main reservoirs and compressors.
2490+
24422491
For EP brakes, two variants are available:
24432492

24442493
- If ``Wagon(ORTSEPBrakeControlsBrakePipe`` is set to 0 (default situation),
@@ -3111,27 +3160,16 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
31113160
single: ORTSEmergencyValveActuationRate
31123161
single: ORTSEmergencyDumpValveRate
31133162
single: ORTSEmergencyDumpValveTimer
3114-
single: ORTSEmergencyQuickAction
31153163
single: ORTSEmergencyResQuickRelease
31163164
single: ORTSMainResPipeAuxResCharging
31173165
single: ORTSBrakeRelayValveRatio
3118-
single: ORTSBrakeRelayValveInshot
31193166
single: ORTSEngineBrakeRelayValveRatio
3120-
single: ORTSEngineBrakeRelayValveInshot
31213167
single: ORTSBrakeRelayValveApplicationRate
31223168
single: ORTSBrakeRelayValveReleaseRate
31233169
single: ORTSMaxTripleValveCylinderPressure
31243170
single: ORTSMaxServiceCylinderPressure
3125-
single: ORTSMaxServiceApplicationRate
3126-
single: ORTSTwoStageLowPressure
3127-
single: ORTSTwoStageRelayValveRatio
3128-
single: ORTSTwoStageIncreasingSpeed
3129-
single: ORTSTwoStageDecreasingSpeed
3130-
single: ORTSHighSpeedReducingPressure
31313171
single: ORTSUniformChargingThreshold
31323172
single: ORTSUniformChargingRatio
3133-
single: ORTSUniformReleaseThreshold
3134-
single: ORTSUniformReleaseRatio
31353173
single: ORTSQuickServiceLimit
31363174
single: ORTSQuickServiceApplicationRate
31373175
single: ORTSQuickServiceVentRate
@@ -3149,9 +3187,6 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
31493187
single: ORTSBrakePipeTimeFactor
31503188
single: ORTSEPBrakeControlsBrakePipe
31513189
single: ORTSCompressorIsMuControlled
3152-
single: Supply_Reservoir
3153-
single: ORTSSupplyResCapacity
3154-
single: ORTSSupplyResChargingRate
31553190

31563191
- ``Wagon(BrakePipeVolume`` -- Volume of car's brake pipe in cubic feet
31573192
(default .5).
@@ -3178,17 +3213,12 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
31783213
- ``Wagon(ORTSEmergencyDumpValveTimer`` -- Timer for emergency dump valve to close
31793214
after it is activated. If set to 0, it will close as soon as BP is discharged.
31803215
Default value will prevent BP from being charged for 2 minutes.
3181-
- ``Wagon(ORTSEmergencyQuickAction`` -- If set to 1, air from the brake pipe will
3182-
be sent to the brake cylinder at MaxApplicationRate during emergency applications.
3183-
Speeds up emergency application along the entire train. (default 0)
31843216
- ``Wagon(ORTSEmergencyResQuickRelease`` -- Set to 1 (default 0) to enable quick release,
31853217
in which emergency reservoir air is used to increase the brake pipe pressure
3186-
during release. Remains active until aux res has recharged.
3218+
during release. Remains active until brake cylinder pressure drops below 5 psi.
31873219
- ``Wagon(ORTSMainResPipeAuxResCharging`` -- Boolean value that indicates,
31883220
for twin pipe systems, if the main reservoir pipe is used for charging the auxiliary
3189-
reservoirs. Alternately, if equipped with a supply reservoir, the supply reservoir
3190-
will charge from the main reservoir pipe instead. If set to false, the main reservoir
3191-
pipe will not be used (default: true).
3221+
reservoirs. If set to false, the main reservoir pipe will not be used
31923222
by the brake system.
31933223
- ``Wagon(ORTSEPBrakeControlsBrakePipe`` -- Set to 1 for UIC EP brake: brake pipe
31943224
pressure is electrically controlled at every fitted car.
@@ -3197,15 +3227,7 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
31973227
This is achieved via a relay valve which sets BC pressure proportionally.
31983228
Relay valves may be installed to achieve higher brake cylinder pressures,
31993229
dynamic brake blending or variable load compensation.
3200-
- ``Wagon(ORTSBrakeRelayValveInshot`` -- Sets the "in-shot" pressure for the relay
3201-
valve. This pressure will be added to the regular output of the relay valve for any
3202-
application, effectively setting a minimum brake cylinder pressure. Many step down
3203-
relay valves (ratio less than 1) utilize in-shot to ensure brake cylinders extend
3204-
fully for light train brake applications.
3205-
- ``Wagon(ORTSEngineBrakeRelayValveRatio`` -- Same as ``ORTSBrakeRelayValveRatio``,
3206-
but for the engine brake.
3207-
- ``Wagon(ORTSEngineBrakeRelayValveInshot`` -- Same as ``ORTSBrakeRelayValveInshot``,
3208-
but for the engine brake.
3230+
- ``Wagon(ORTSBrakeRelayValveRatio`` -- Same as above, but for the engine brake
32093231
- ``Wagon(ORTSBrakeRelayValveApplicationRate`` -- Brake cylinder pressure application
32103232
rate achieved by the relay valve, if fitted.
32113233
- ``Wagon(ORTSBrakeRelayValveReleaseRate`` -- Brake cylinder pressure release
@@ -3217,35 +3239,12 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
32173239
- ``Wagon(ORTSMaxServiceCylinderPressure`` -- Sets the maximum cylinder pressure
32183240
demanded during service applications. During emergency applications,
32193241
brake cylinder pressure is instead limited by ``ORTSMaxTripleValveCylinderPressure``.
3220-
- ``Wagon(ORTSMaxServiceApplicationRate`` -- Sets the maximum application rate
3221-
allowed during service applications. For emergency applications, the application
3222-
rate will be limited by ``MaxApplicationRate``.
3223-
- ``Wagon(ORTSTwoStageLowPressure`` -- For two stage braking systems where brake force
3224-
is reduced at lower speeds and increased at higher speeds, sets the maximum cylinder
3225-
pressure demanded when at slower speeds (defaults to 0, disabling two stage braking).
3226-
For high speed, use ``ORTSMaxTripleValveCylinderPressure`` to set the pressure limit.
3227-
- ``Wagon(ORTSTwoStageRelayValveRatio`` -- Alternatey, sets a relay valve ratio to
3228-
be used by the two stage system at low speeds. At high speed, the relay valve
3229-
uses the ratio set by ``ORTSBrakeRelayValveRatio``.
3230-
- ``Wagon(ORTSTwoStageIncreasingSpeed`` -- The speed at which the two stage braking
3231-
system changes from low pressure to high pressure during acceleration.
3232-
- ``Wagon(ORTSTwoStageDecreasingSpeed`` -- The speed at which the two stage braking
3233-
system changes from high pressure to low pressure during deceleration.
3234-
- ``Wagon(ORTSHighSpeedReducingPressure`` -- If the demanded brake cylinder pressure
3235-
exceeds this value, the brakes will gradually release to this pressure. Simulates
3236-
the high speed reducing valve (HSRV). (default 0 for wagons with no HSRV)
32373242
- ``Wagon(ORTSUniformChargingThreshold`` -- The pressure difference between the brake
32383243
pipe and auxiliary reservoir at which uniform charging activates during release
32393244
(default 3 psi), usually used to reduce the rate of auxiliary reservoir charging.
32403245
- ``Wagon(ORTSUniformChargingRatio`` -- Factor used to divide auxiliary reservoir
32413246
charging rate by when uniform charging is active. Eg: setting of 2 will halve
32423247
charging rate while uniform charging is active (defaults to 0, disabling the feature).
3243-
- ``Wagon(ORTSUniformReleaseThreshold`` -- The pressure difference between the brake
3244-
pipe and auxiliary reservoir at which uniform release activates during release
3245-
(default 3 psi), usually used to reduce the rate of brake cylinder release.
3246-
- ``Wagon(ORTSUniformReleaseRatio`` -- Factor used to divide brake cylinder
3247-
release rate by when uniform release is active. Eg: setting of 2 will halve
3248-
release rate while uniform release is active (defaults to 0, disabling the feature).
32493248
- ``Wagon(ORTSQuickServiceLimit`` -- Quick service activates when triple valve
32503249
initially changes from release to apply, and will remain active until brake
32513250
cylinder pressure reaches the pressure specified here (default 0,
@@ -3271,16 +3270,6 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
32713270
- ``Wagon(ORTSCylinderSpringPressure`` -- Below the specified pressure, no
32723271
brake force will be developed, simulating the pressure required to
32733272
overcome the brake cylinder return spring (default 0).
3274-
- ``BrakeEquipmentType(Supply_Reservoir`` -- Adds a supply reservoir to the
3275-
loco or wagon, which will constantly charge to the brake pipe pressure
3276-
or MR pipe (if equipped) pressure. If a supply reservoir is equipped,
3277-
supply res air will be used to pressurize the brake cylinders thru the relay
3278-
valve. This allows for a small, fast charging auxiliary reservoir to
3279-
be used with large brake cylinders.
3280-
- ``Wagon(ORTSSupplyResCapacity`` -- Volume of the supply reservoir. Larger
3281-
volumes relative to the brake cylinder volume allow for more brake applications.
3282-
- ``Wagon(ORTSSupplyResChargingRate`` -- The rate at which the pressure of the
3283-
supply reservoir will increase when charging from the brake pipe or MR pipe.
32843273
- ``Engine(ORTSMainResChargingRate`` -- Rate of main reservoir pressure change
32853274
in psi per second when the compressor is on (default .4).
32863275
- ``Engine(ORTSEngineBrakeReleaseRate`` -- Rate of engine brake pressure

Source/Orts.Formats.Msts/CabViewFile.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ public enum CABViewControlTypes
201201
ORTS_QUICKRELEASE,
202202
ORTS_OVERCHARGE,
203203
ORTS_AIR_FLOW_METER,
204+
ORTS_TRAIN_AIR_FLOW_METER,
204205
ORTS_BATTERY_SWITCH_COMMAND_SWITCH,
205206
ORTS_BATTERY_SWITCH_COMMAND_BUTTON_CLOSE,
206207
ORTS_BATTERY_SWITCH_COMMAND_BUTTON_OPEN,

0 commit comments

Comments
 (0)