Skip to content

Commit 55f3ff8

Browse files
CsantucciCsantucci
authored
Merge pull request #546 from Csantucci/Multiple-screens-official
Blueprint https://blueprints.launchpad.net/or/+spec/multiple-screen-pages in 2D and 3D cabs
2 parents 6a56c0d + 3be6354 commit 55f3ff8

File tree

6 files changed

+426
-60
lines changed

6 files changed

+426
-60
lines changed

‎Source/Documentation/Manual/cabs.rst

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,60 @@ if e.g. the wiper moves from left to right and back, only the frames related
466466
to the motion from left to right have to be included. For the reverse
467467
motion the same frames are used from last to first. SwitchVal can vary from 0 to 1.
468468

469+
Multiple screen pages on displays
470+
---------------------------------
471+
472+
Modern locomotives have one or more displays in their cabs, and often in such
473+
displays it is possible to switch among more screen pages. Fields and controls
474+
described in this paragraph enable the implementation of .cvf files with such
475+
functionality, for both 2D and 3D cabs.
476+
477+
In the .cvf control blocks following further fields may be optionally present::
478+
479+
ORTSDisplay ( numeric ), indicating the display ID number (from 0 to 7)
480+
to which the control is linked; if such field is missing, display ID number
481+
zero is assumed;
482+
483+
ORTSScreenPage ( alphanumeric-string ) indicating the screen ID string to
484+
which the control is linked; that means that the control is displayed/may be
485+
operated only if its screen is active in that moment; a missing entry
486+
indicates that the control is displayed independently from the selected screen page;
487+
at game start such controls are enabled, plus the ones with line
488+
ORTSScreenPage ( "default" ); more ORTSScreenPage() entries in a single control
489+
are possible.
490+
491+
A new on/off control, called ORTS_SCREEN_SELECT is available, which, in addition to the usual fields and to
492+
the optional fields ORTSDisplay and ORTSScreenPage contains one or more of following fields::
493+
494+
ORTSNewScreenPage ( alphanumeric-string numeric ): when the control is clicked,
495+
the controls with field ORTSScreenPage equal to the string of this field and
496+
with field ORTSDisplay equal to the numeric will be displayed on such display
497+
in place of the ones displayed up to that moment. if the numeric is missing within
498+
ORTSNewScreenPage, the involved display is the one referenced in field ORTSDisplay
499+
of ORTS_SCREEN_SELECT.
500+
501+
A further control is available, named ORTS_STATIC_DISPLAY, which is specially devoted to the loading of the
502+
background of screen pages (their static part).
503+
Here is an example of usage of it::
504+
505+
MultiStateDisplay (
506+
Type ( ORTS_STATIC_DISPLAY MULTI_STATE_DISPLAY )
507+
Position ( 246 151 105 16 )
508+
Graphic ( semproniostatic.ace )
509+
States ( 1 1 1
510+
State (
511+
Style ( 0 )
512+
SwitchVal ( 0 )
513+
)
514+
)
515+
ORTSScreenPage ( "sempronio" )
516+
)
517+
518+
With this block, the static part of the "sempronio" screen page is loaded on display 0 when such screen
519+
becomes the active one.
520+
521+
.cvf files not using fields and controls listed in this paragraph work as usual, with no changes needed.
522+
469523
Further OR cab controls
470524
-----------------------
471525

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

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,8 @@ public enum CABViewControlTypes
204204
ORTS_2DEXTERNALWIPERS,
205205
ORTS_GENERIC_ITEM1,
206206
ORTS_GENERIC_ITEM2,
207+
ORTS_SCREEN_SELECT,
208+
ORTS_STATIC_DISPLAY,
207209

208210
// TCS Controls
209211
ORTS_TCS1,
@@ -392,6 +394,10 @@ public class CabViewControl
392394
public double OldValue;
393395
public string ACEFile = "";
394396

397+
public int Display;
398+
public List<string> Screens;
399+
public int CabViewpoint;
400+
395401
public CABViewControlTypes ControlType = CABViewControlTypes.NONE;
396402
public CABViewControlStyles ControlStyle = CABViewControlStyles.NONE;
397403
public CABViewControlUnits Units = CABViewControlUnits.NONE;
@@ -511,6 +517,32 @@ protected virtual float ParseRotation(STFReader stf)
511517
stf.SkipRestOfBlock();
512518
return rotation;
513519
}
520+
521+
protected virtual void ParseDisplay(STFReader stf)
522+
{
523+
stf.MustMatch("(");
524+
Display = stf.ReadInt(0);
525+
stf.SkipRestOfBlock();
526+
}
527+
528+
protected virtual void ParseScreen(STFReader stf)
529+
{
530+
stf.MustMatch("(");
531+
var newScreen = stf.ReadString();
532+
stf.SkipRestOfBlock();
533+
if (Screens == null)
534+
Screens = new List<string>();
535+
Screens.Add(newScreen.ToLower());
536+
}
537+
538+
protected virtual void ParseCabViewpoint(STFReader stf)
539+
{
540+
stf.MustMatch("(");
541+
CabViewpoint = stf.ReadInt(0);
542+
stf.SkipRestOfBlock();
543+
}
544+
545+
514546
}
515547
#endregion
516548

@@ -562,6 +594,9 @@ public CVCDial(STFReader stf, string basepath)
562594
ToDegree = stf.ReadFloat(STFReader.UNITS.None, null);
563595
stf.SkipRestOfBlock();
564596
}),
597+
new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
598+
new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
599+
new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
565600
});
566601
}
567602
}
@@ -647,7 +682,10 @@ public CVCGauge(STFReader stf, string basepath)
647682
new STFReader.TokenProcessor("controlcolour", ()=>{ DecreaseColor = ParseControlColor(stf); }) });
648683
}
649684
}),
650-
new STFReader.TokenProcessor("ortsangle", () =>{ Rotation = ParseRotation(stf); })
685+
new STFReader.TokenProcessor("ortsangle", () =>{ Rotation = ParseRotation(stf); }),
686+
new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
687+
new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
688+
new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
651689
});
652690
}
653691
}
@@ -770,7 +808,10 @@ public CVCDigital(STFReader stf, string basepath)
770808
}
771809
}),
772810
new STFReader.TokenProcessor("ortsfont", ()=>{ParseFont(stf); }),
773-
new STFReader.TokenProcessor("ortsangle", () => {Rotation = ParseRotation(stf); }),
811+
new STFReader.TokenProcessor("ortsangle", () => {Rotation = ParseRotation(stf); }),
812+
new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
813+
new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
814+
new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
774815
});
775816
}
776817

@@ -831,7 +872,10 @@ public CVCDigitalClock(STFReader stf, string basepath)
831872
new STFReader.TokenProcessor("accuracy", ()=>{ ParseAccuracy(stf); }),
832873
new STFReader.TokenProcessor("controlcolour", ()=>{ PositiveColor = ParseControlColor(stf); }),
833874
new STFReader.TokenProcessor("ortsfont", ()=>{ParseFont(stf); }),
834-
new STFReader.TokenProcessor("ortsangle", () => { Rotation = ParseRotation(stf); })
875+
new STFReader.TokenProcessor("ortsangle", () => { Rotation = ParseRotation(stf); }),
876+
new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
877+
new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
878+
new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
835879
});
836880
}
837881

@@ -868,6 +912,14 @@ public class CVCDiscrete : CVCWithFrames
868912
private int numPositions;
869913
private bool canFill = true;
870914

915+
public struct NewScreenData
916+
{
917+
public string NewScreen;
918+
public int NewScreenDisplay;
919+
920+
}
921+
public List<NewScreenData> NewScreens;
922+
871923
public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
872924
{
873925
// try
@@ -1001,6 +1053,10 @@ public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
10011053
_ValuesRead++;
10021054
}
10031055
}),
1056+
new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
1057+
new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
1058+
new STFReader.TokenProcessor("ortsnewscreenpage", () => {ParseNewScreen(stf); }),
1059+
new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
10041060
});
10051061

10061062
// If no ACE, just don't need any fixup
@@ -1190,6 +1246,18 @@ public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
11901246
// throw new STFException(stf, "Problem with NumPositions/NumValues/NumFrames/ScaleRange");
11911247
// } // End of Need check the Values collection for validity
11921248
} // End of Constructor
1249+
1250+
protected void ParseNewScreen(STFReader stf)
1251+
{
1252+
stf.MustMatch("(");
1253+
var newScreen = new NewScreenData();
1254+
newScreen.NewScreen = stf.ReadString().ToLower();
1255+
newScreen.NewScreenDisplay = stf.ReadInt(-1);
1256+
stf.SkipRestOfBlock();
1257+
if (NewScreens == null)
1258+
NewScreens = new List<NewScreenData>();
1259+
NewScreens.Add(newScreen); ;
1260+
}
11931261
}
11941262
#endregion
11951263

@@ -1230,6 +1298,9 @@ public CVCMultiStateDisplay(STFReader stf, string basepath)
12301298
for (int i = Values.Count; i < FramesCount; i++)
12311299
Values.Add(-10000);
12321300
}),
1301+
new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
1302+
new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
1303+
new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
12331304
});
12341305
}
12351306
protected int ParseNumStyle(STFReader stf)
@@ -1277,6 +1348,9 @@ public CVCAnimatedDisplay(STFReader stf, string basepath)
12771348
for (int i = Values.Count; i < FramesCount; i++)
12781349
Values.Add(-10000);
12791350
}),
1351+
new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
1352+
new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
1353+
new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
12801354
});
12811355
}
12821356
protected int ParseNumStyle(STFReader stf)
@@ -1309,6 +1383,9 @@ public CVCScreen(STFReader stf, string basepath)
13091383
new STFReader.TokenProcessor("parameters", ()=>{ ParseCustomParameters(stf); }),
13101384
new STFReader.TokenProcessor("disablediflowvoltagepowersupplyoff", ()=>{ ParseDisabledIfLowVoltagePowerSupplyOff(stf); }),
13111385
new STFReader.TokenProcessor("disabledifcabpowersupplyoff", ()=>{ ParseDisabledIfCabPowerSupplyOff(stf); }),
1386+
new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
1387+
new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
1388+
new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
13121389
});
13131390
}
13141391
protected void ParseCustomParameters(STFReader stf)

‎Source/RunActivity/Viewer3D/Commands.cs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,32 @@ public override void Redo()
8989
}
9090
}
9191

92+
93+
[Serializable()]
94+
public sealed class SelectScreenCommand : BooleanCommand
95+
{
96+
public static CabRenderer Receiver { get; set; }
97+
98+
public SelectScreenCommand(CommandLog log, bool toState, string screen, int display)
99+
: base(log, toState)
100+
{
101+
Redo(screen, display);
102+
}
103+
104+
public void Redo(string screen, int display)
105+
{
106+
if (ToState)
107+
{
108+
Receiver.ActiveScreen[display] = screen;
109+
}
110+
}
111+
112+
public override string ToString()
113+
{
114+
return base.ToString();
115+
}
116+
}
117+
92118
// Other
93119
[Serializable()]
94120
public sealed class ChangeCabCommand : Command

0 commit comments

Comments
 (0)