Skip to content

Commit 51d4cd9

Browse files
cjakemancjakeman
authored
Merge pull request #751 from cesarBLG/external-controllers
Web interface to control cab controls with external hardware
2 parents b79cb2d + 00981a2 commit 51d4cd9

File tree

9 files changed

+314
-159
lines changed

9 files changed

+314
-159
lines changed

‎Source/Orts.Formats.Msts/CabViewFile.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,11 @@ public struct CabViewControlType
343343
{
344344
public CABViewControlTypes Type;
345345
public int Id;
346+
public CabViewControlType(CABViewControlTypes type)
347+
{
348+
Type = type;
349+
Id = 0;
350+
}
346351
public CabViewControlType(string name)
347352
{
348353
Type = CABViewControlTypes.NONE;

‎Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3860,6 +3860,8 @@ public void SetThrottlePercent(float percent)
38603860
if (!CruiseControl.UseThrottleInCombinedControl) ThrottleController.SetPercent(percent);
38613861
return;
38623862
}
3863+
else if (CruiseControl.UseThrottleAsSpeedSelector && CruiseControl.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Auto)
3864+
CruiseControl.SetSpeed(MpS.FromMpS(percent * MaxSpeedMpS / 100, !CruiseControl.SpeedIsMph));
38633865
else
38643866
ThrottleController.SetPercent(percent);
38653867
}

‎Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs‎

Lines changed: 63 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -236,46 +236,71 @@ public override void HandleUserInput(ElapsedTime elapsedTime)
236236
if (UserInput.IsPressed(UserCommand.DebugResetWheelSlip)) { Locomotive.Train.SignalEvent(Event._ResetWheelSlip); }
237237
if (UserInput.IsPressed(UserCommand.DebugToggleAdvancedAdhesion)) { Locomotive.Train.SignalEvent(Event._ResetWheelSlip); Locomotive.Simulator.UseAdvancedAdhesion = !Locomotive.Simulator.UseAdvancedAdhesion; }
238238

239-
if (UserInput.RDState != null)
239+
ExternalDeviceState[] externalDevices = {UserInput.RDState, UserInput.WebDeviceState};
240+
foreach (var external in externalDevices)
240241
{
241-
if (UserInput.RDState.BailOff)
242+
if (external == null) continue;
243+
// Handle other cabcontrols
244+
foreach (var kvp in external.CabControls)
242245
{
243-
Locomotive.SetBailOff(true);
244-
}
245-
if (UserInput.RDState.Changed)
246-
{
247-
Locomotive.AlerterReset();
248-
249-
Locomotive.SetThrottlePercentWithSound(UserInput.RDState.ThrottlePercent);
250-
Locomotive.SetTrainBrakePercent(UserInput.RDState.TrainBrakePercent);
251-
Locomotive.SetEngineBrakePercent(UserInput.RDState.EngineBrakePercent);
252-
// Locomotive.SetBrakemanBrakePercent(UserInput.RDState.BrakemanBrakePercent); // For Raildriver control not complete for this value?
253-
if (Locomotive.CombinedControlType != MSTSLocomotive.CombinedControl.ThrottleAir)
254-
Locomotive.SetDynamicBrakePercentWithSound(UserInput.RDState.DynamicBrakePercent);
255-
if (UserInput.RDState.DirectionPercent > 50)
256-
Locomotive.SetDirection(Direction.Forward);
257-
else if (UserInput.RDState.DirectionPercent < -50)
258-
Locomotive.SetDirection(Direction.Reverse);
259-
else
260-
Locomotive.SetDirection(Direction.N);
261-
if (UserInput.RDState.Emergency)
262-
new EmergencyPushButtonCommand(Viewer.Log, true);
263-
else
264-
new EmergencyPushButtonCommand(Viewer.Log, false);
265-
if (UserInput.RDState.Wipers == 1 && Locomotive.Wiper)
266-
Locomotive.SignalEvent(Event.WiperOff);
267-
if (UserInput.RDState.Wipers != 1 && !Locomotive.Wiper)
268-
Locomotive.SignalEvent(Event.WiperOn);
269-
// changing Headlight more than one step at a time doesn't work for some reason
270-
if (Locomotive.Headlight < UserInput.RDState.Lights - 1)
271-
{
272-
Locomotive.Headlight++;
273-
Locomotive.SignalEvent(Event.LightSwitchToggle);
274-
}
275-
if (Locomotive.Headlight > UserInput.RDState.Lights - 1)
246+
if (!kvp.Value.Changed) continue;
247+
float val = kvp.Value.Value;
248+
switch (kvp.Key.Item1.Type)
276249
{
277-
Locomotive.Headlight--;
278-
Locomotive.SignalEvent(Event.LightSwitchToggle);
250+
// Some cab controls need specific handling for better results
251+
case CABViewControlTypes.THROTTLE:
252+
Locomotive.SetThrottlePercentWithSound(val * 100);
253+
break;
254+
case CABViewControlTypes.DIRECTION:
255+
if (Locomotive is MSTSSteamLocomotive steam)
256+
{
257+
steam.SetCutoffPercent(val * 100);
258+
}
259+
else if (val > 0.5f)
260+
Locomotive.SetDirection(Direction.Forward);
261+
else if (val < -0.5f)
262+
Locomotive.SetDirection(Direction.Reverse);
263+
else
264+
Locomotive.SetDirection(Direction.N);
265+
break;
266+
case CABViewControlTypes.TRAIN_BRAKE:
267+
Locomotive.SetTrainBrakePercent(val * 100);
268+
break;
269+
case CABViewControlTypes.DYNAMIC_BRAKE:
270+
if (Locomotive.CombinedControlType != MSTSLocomotive.CombinedControl.ThrottleAir)
271+
Locomotive.SetDynamicBrakePercentWithSound(val * 100);
272+
break;
273+
case CABViewControlTypes.ENGINE_BRAKE:
274+
Locomotive.SetEngineBrakePercent(val * 100);
275+
break;
276+
case CABViewControlTypes.FRONT_HLIGHT:
277+
// changing Headlight more than one step at a time doesn't work for some reason
278+
if (Locomotive.Headlight < val - 1)
279+
{
280+
Locomotive.Headlight++;
281+
Locomotive.SignalEvent(Event.LightSwitchToggle);
282+
}
283+
if (Locomotive.Headlight > val - 1)
284+
{
285+
Locomotive.Headlight--;
286+
Locomotive.SignalEvent(Event.LightSwitchToggle);
287+
}
288+
break;
289+
case CABViewControlTypes.ORTS_SELECTED_SPEED_SELECTOR:
290+
Locomotive.CruiseControl.SelectedSpeedMpS = val;
291+
break;
292+
// Other controls can hopefully be controlled faking mouse input
293+
// TODO: refactor HandleUserInput()
294+
default:
295+
var cabRenderer = ThreeDimentionCabRenderer ?? _CabRenderer;
296+
if (cabRenderer != null && cabRenderer.ControlMap.TryGetValue(kvp.Key, out var renderer) && renderer is CabViewDiscreteRenderer discrete)
297+
{
298+
var oldChanged = discrete.ChangedValue;
299+
discrete.ChangedValue = (oldval) => val;
300+
discrete.HandleUserInput();
301+
discrete.ChangedValue = oldChanged;
302+
}
303+
break;
279304
}
280305
}
281306
}
@@ -1982,7 +2007,7 @@ public class CabViewDiscreteRenderer : CabViewControlRenderer, ICabViewMouseCont
19822007
/// <summary>
19832008
/// Function calculating response value for mouse events (movement, left-click), determined by configured style.
19842009
/// </summary>
1985-
readonly Func<float, float> ChangedValue;
2010+
public Func<float, float> ChangedValue;
19862011

19872012
public CabViewDiscreteRenderer(Viewer viewer, MSTSLocomotive locomotive, CVCWithFrames control, CabShader shader)
19882013
: base(viewer, locomotive, control, shader)

‎Source/RunActivity/Viewer3D/RollingStock/MSTSSteamLocomotiveViewer.cs‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,9 +225,6 @@ public override void HandleUserInput(ElapsedTime elapsedTime)
225225
// Keeping separated, since it is not a real engine control. (Probably wrong classification?)
226226
if (UserInput.IsPressed(UserCommand.ControlAIFireReset)) new AIFireResetCommand(Viewer.Log);
227227

228-
if (UserInput.RDState != null && UserInput.RDState.Changed)
229-
SteamLocomotive.SetCutoffPercent(UserInput.RDState.DirectionPercent);
230-
231228
base.HandleUserInput(elapsedTime);
232229

233230
#if DEBUG_DUMP_STEAM_POWER_CURVE

‎Source/RunActivity/Viewer3D/UserInput.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ public static class UserInput
4949
static bool MouseButtonsSwapped;
5050
public static int MouseSpeedX;
5151
public static int MouseSpeedY;
52-
5352
public static RailDriverState RDState;
53+
public static ExternalDeviceState WebDeviceState = new ExternalDeviceState();
5454

5555
static InputSettings InputSettings;
5656

@@ -136,8 +136,8 @@ static Keys[] GetKeysWithPrintScreenFix(KeyboardState keyboardState)
136136

137137
public static void Handled()
138138
{
139-
if (RDState != null)
140-
RDState.Handled();
139+
RDState?.Handled();
140+
WebDeviceState?.Handled();
141141
}
142142

143143
public static bool IsPressed(UserCommand command)

‎Source/RunActivity/Viewer3D/UserInputExternal.cs‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
// COPYRIGHT 2022 by the Open Rails project.
2+
//
3+
// This file is part of Open Rails.
4+
//
5+
// Open Rails is free software: you can redistribute it and/or modify
6+
// it under the terms of the GNU General Public License as published by
7+
// the Free Software Foundation, either version 3 of the License, or
8+
// (at your option) any later version.
9+
//
10+
// Open Rails is distributed in the hope that it will be useful,
11+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
// GNU General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU General Public License
16+
// along with Open Rails. If not, see <http://www.gnu.org/licenses/>.
17+
18+
using System;
19+
using System.Collections.Generic;
20+
using Orts.Formats.Msts;
21+
using Orts.Simulation.RollingStocks;
22+
using ORTS.Common;
23+
using ORTS.Common.Input;
24+
25+
namespace Orts.Viewer3D
26+
{
27+
/// <summary>
28+
/// Processed external device data sent to UserInput class
29+
/// </summary>
30+
public class ExternalDeviceState
31+
{
32+
public Dictionary<(CabViewControlType,int), ExternalDeviceCabControl> CabControls;
33+
public Dictionary<UserCommand, ExternalDeviceButton> Commands;
34+
public ExternalDeviceState()
35+
{
36+
Commands = new Dictionary<UserCommand, ExternalDeviceButton>();
37+
CabControls = new Dictionary<(CabViewControlType,int), ExternalDeviceCabControl>();
38+
}
39+
40+
public virtual void Handled()
41+
{
42+
foreach (var button in Commands.Values)
43+
{
44+
button.Changed = false;
45+
}
46+
foreach (var control in CabControls.Values)
47+
{
48+
control.Changed = false;
49+
}
50+
}
51+
52+
public bool IsPressed(UserCommand command)
53+
{
54+
return Commands.TryGetValue(command, out var button) && button.IsPressed;
55+
}
56+
57+
public bool IsReleased(UserCommand command)
58+
{
59+
return Commands.TryGetValue(command, out var button) && button.IsReleased;
60+
}
61+
62+
public bool IsDown(UserCommand command)
63+
{
64+
return Commands.TryGetValue(command, out var button) && button.IsDown;
65+
}
66+
}
67+
public class ExternalDeviceButton
68+
{
69+
bool isDown;
70+
public bool IsDown
71+
{
72+
get
73+
{
74+
return isDown;
75+
}
76+
set
77+
{
78+
if (isDown != value)
79+
{
80+
isDown = value;
81+
Changed = true;
82+
}
83+
}
84+
}
85+
public bool IsPressed { get { return IsDown && Changed; } }
86+
public bool IsReleased { get { return !IsDown && Changed; } }
87+
public bool Changed;
88+
}
89+
public class ExternalDeviceCabControl
90+
{
91+
float value;
92+
public bool Changed;
93+
public float Value
94+
{
95+
get
96+
{
97+
return value;
98+
}
99+
set
100+
{
101+
if (this.value != value)
102+
{
103+
this.value = value;
104+
Changed = true;
105+
}
106+
}
107+
}
108+
}
109+
}

0 commit comments

Comments
 (0)