Merge pull request #392 from Csantucci/elevator

Blueprint https://blueprints.launchpad.net/or/+spec/trainset-elevator Trainset elevator

Author: cjakeman

Source/Documentation/Manual/features-route.rst

@@ -313,6 +313,98 @@ The animation block for the above transfertable is as follows::
 3600 is not a mandatory value, however to have a reasonable transfer speed a number of 
 animation keys equal to 60 - 90 every meter should be selected. 
 
+
+Locomotive and wagon elevators
+------------------------------
+.. index::
+   single: Elevator
+
+The elevator is managed by ORTS as a  vertically moving transfertable. So files needed 
+are the same as used for a transfertable, with content modified where needed.
+
+Info to identify an elevator in a route is stored in file turntables.dat, as it is 
+for turntables and transfertables. The same file can store info for moving tables of 
+different types. Here a turntables.dat file that contains info for an elevator::
+
+  1
+  Transfertable(
+  WFile ( "w-005578+014976.w" )
+  UiD ( 75 )
+  XOffset ( 0 )
+  YOffset ( -0.18 )
+  ZOffset ( 13.405)
+  VerticalTransfer ( 1 )
+  TrackShapeIndex ( 37301 )
+  Animation ( "TRACKPIECE" )
+  Length ( 26.81 )
+  )
+
+What identifies this as an elevator is the presence of the VerticalTransfer parameter 
+with value 1. The other difference to a transfertable is the presence of the YOffset 
+parameter, which is the vertical offset of the zero position of the elevator with respect to 
+the shape file zero.
+
+An example of the animation block in the elevator shape file is shown here below::
+
+	animations ( 1
+		animation ( 1800 30
+			anim_nodes ( 2
+				anim_node BASIN (
+					controllers ( 0 )
+				)
+				anim_node TRACKPIECE (
+					controllers ( 1
+						linear_pos ( 2
+              linear_key (	0	0	-1.92177	0	 )
+              linear_key (	1800	0	6.07823	0	 )
+						)					
+					)
+				)
+			)
+		)
+	)
+
+wich generates a vertical movement with a span of 8 meters which is covered in 60 
+seconds. Of course the 1800 value may be modified to get the desired motion speed.
+
+The elevator must also be defined as a TrackShape in tsection.dat. It is suggested 
+to define it in a route specific ``tsection.dat`` extension file, which, for the 
+sample elevator, is as follows::
+
+
+  
+  include ( "../../../Global/tsection.dat" )
+  _INFO ( Track section and shape addition for transfer table derived from turntable 27m )
+  
+  TrackSections ( 40000
+  
+  _SKIP ( No change here )
+  
+  )
+  
+  
+  TrackShapes ( 40000
+  
+  _INFO(TrackShape for for vertical transfer table derived from turntable 27m)
+   
+  TrackShape ( 37301
+   FileName ( A1t27mVerticalTransfertable.s )
+    NumPaths ( 2 )
+    SectionIdx ( 1 0 -0.18 0.0000 0 338 )
+    SectionIdx ( 1 0 7.82 0.0000 0 338 )
+   )
+  )
+
+To insert the elevator in a route using TSRE5 it must be reminded that the latter 
+doesn't look at the tsection.dat file within the Openrails subfolder. So, for the sole 
+time of the editing of the route, the TrackShape() block must be inserted in the global 
+tsection.dat. After route editing is terminated, the block may be removed.
+Tsection.dat build 38 or higher is required within the main Global folder.
+
+At runtime the elevator is moved with the keys used for transfertables and turntables. 
+Alt-C moves the elevator upwards, while Ctrl-C moves the elevator downwards.
+
+
 .. _features-route-turntable-operation:
 
 Path laying and operation considerations

Source/Orts.Simulation/Simulation/Transfertables.cs

@@ -40,16 +40,21 @@ namespace Orts.Simulation
 
     public class Transfertable : MovingTable
     {
-        public float Width;
+        public float Span; // horizontal or vertical
         public List<float> Offsets = new List<float>();
+        private bool VerticalTransfer = false;
+        public float CenterOffsetComponent
+        {
+            get => VerticalTransfer ? CenterOffset.Y : CenterOffset.X;
+        }
         // Dynamic data
         public bool Forward; // forward motion on
         public bool Reverse; // reverse motion on
-        public float XPos = 0; // X Position of animated part, to be compared with X positions of endpoints
+        public float OffsetPos = 0; // Offset Position of animated part, to be compared with offset positions of endpoints
         public bool Connected = true; // Transfertable is connected to a track
         public bool SaveConnected = true; // Transfertable is connected to a track
         public int ConnectedTarget = -1; // index of trackend connected
-        public float TargetX = 0; //final target for Viewer;
+        public float TargetOffset = 0; //final target for Viewer;
 
         public Signals signalRef { get; protected set; }
 
@@ -68,9 +73,11 @@ public Transfertable(STFReader stf, Simulator simulator): base(stf, simulator)
                 new STFReader.TokenProcessor("uid", ()=>{ UID = stf.ReadIntBlock(-1); }),
                 new STFReader.TokenProcessor("animation", ()=>{ animation = stf.ReadStringBlock(null);
                                                                 Animations.Add(animation.ToLower());}),
+                new STFReader.TokenProcessor("verticaltransfer", ()=>{ VerticalTransfer = stf.ReadBoolBlock(false);}),
                 new STFReader.TokenProcessor("length", ()=>{ Length = stf.ReadFloatBlock(STFReader.UNITS.None , null);}),
                 new STFReader.TokenProcessor("xoffset", ()=>{ CenterOffset.X = stf.ReadFloatBlock(STFReader.UNITS.None , null);}),
                 new STFReader.TokenProcessor("zoffset", ()=>{ CenterOffset.Z = -stf.ReadFloatBlock(STFReader.UNITS.None , null);}),
+                new STFReader.TokenProcessor("yoffset", ()=>{ CenterOffset.Y = stf.ReadFloatBlock(STFReader.UNITS.None , null);}),
                 new STFReader.TokenProcessor("trackshapeindex", ()=>
                 {
                     TrackShapeIndex = stf.ReadIntBlock(-1);
@@ -88,11 +95,11 @@ public override void Save(BinaryWriter outf)
             base.Save(outf);
             outf.Write(Forward);
             outf.Write(Reverse);
-            outf.Write(XPos);
+            outf.Write(OffsetPos);
             outf.Write(Connected);
             outf.Write(SaveConnected);
             outf.Write(ConnectedTarget);
-            outf.Write(TargetX);
+            outf.Write(TargetOffset);
         }
 
 
@@ -105,11 +112,11 @@ public override void Restore(BinaryReader inf, Simulator simulator)
             base.Restore(inf, simulator);
             Forward = inf.ReadBoolean();
             Reverse = inf.ReadBoolean();
-            XPos = inf.ReadSingle();
+            OffsetPos = inf.ReadSingle();
             Connected = inf.ReadBoolean();
             SaveConnected = inf.ReadBoolean();
             ConnectedTarget = inf.ReadInt32();
-            TargetX = inf.ReadSingle();
+            TargetOffset = inf.ReadSingle();
         }
 
         protected void InitializeOffsetsAndTrackNodes()
@@ -122,7 +129,7 @@ protected void InitializeOffsetsAndTrackNodes()
             var iMyTrackNodes = 0;
             foreach (var sectionIdx in trackShape.SectionIdxs)
             {
-                Offsets.Add((float)sectionIdx.X);
+                Offsets.Add(VerticalTransfer ? (float)sectionIdx.Y : (float)sectionIdx.X);
                 MyTrackNodesIndex[iMyTrackNodes] = -1;
                 MyTrVectorSectionsIndex[iMyTrackNodes] = -1;
                 iMyTrackNodes++;
@@ -148,9 +155,16 @@ protected void InitializeOffsetsAndTrackNodes()
                     }
                 }
             }
-            XPos = CenterOffset.X;
-            // Compute width of transfer table
-            Width = (float)(trackShape.SectionIdxs[trackShape.SectionIdxs.Length - 1].X - trackShape.SectionIdxs[0].X);
+            if (VerticalTransfer)
+            {
+                OffsetPos = CenterOffset.Y;
+                Span = (float)(trackShape.SectionIdxs[trackShape.SectionIdxs.Length - 1].Y - trackShape.SectionIdxs[0].Y);
+            }
+            else
+            {
+                OffsetPos = CenterOffset.X;
+                Span = (float)(trackShape.SectionIdxs[trackShape.SectionIdxs.Length - 1].X - trackShape.SectionIdxs[0].X);
+            }
         }
 
         /// <summary>
@@ -179,7 +193,7 @@ public override void ComputeTarget(bool isForward)
                     {
                         if (MyTrackNodesIndex[iOffset] != -1 && MyTrVectorSectionsIndex[iOffset] != -1)
                         {
-                            var thisOffsetDiff = Offsets[iOffset] - XPos;
+                            var thisOffsetDiff = Offsets[iOffset] - OffsetPos;
                             if (thisOffsetDiff < offsetDiff && thisOffsetDiff >= 0)
                             {
                                 ConnectedTarget = iOffset;
@@ -210,7 +224,7 @@ public override void ComputeTarget(bool isForward)
                     {
                         if (MyTrackNodesIndex[iOffset] != -1 && MyTrVectorSectionsIndex[iOffset] != -1)
                         {
-                            var thisOffsetDiff = Offsets[iOffset] - XPos;
+                            var thisOffsetDiff = Offsets[iOffset] - OffsetPos;
                             if (thisOffsetDiff > offsetDiff && thisOffsetDiff <= 0)
                             {
                                 ConnectedTarget = iOffset;
@@ -292,7 +306,10 @@ public override void StartContinuous(bool isForward)
         public void ComputeCenter(WorldPosition worldPosition)
         {
             Vector3 movingCenterOffset = CenterOffset;
-            movingCenterOffset.X = XPos;
+            if (VerticalTransfer)
+                movingCenterOffset.Y = OffsetPos;
+            else
+                movingCenterOffset.X = OffsetPos;
             Vector3 originCoordinates;
             Vector3.Transform(ref movingCenterOffset, ref worldPosition.XNAMatrix, out originCoordinates);
             WorldPosition = new WorldPosition(worldPosition);
@@ -340,14 +357,14 @@ public override void Update()
                     Connected = false;
                     if (ConnectedTarget != -1)
                     {
-                        if (Offsets[ConnectedTarget] - XPos < 0.005)
+                        if (Offsets[ConnectedTarget] - OffsetPos < 0.005)
                         {
                             Connected = true;
                             Forward = false;
                             ConnectedTrackEnd = ConnectedTarget;
                             Simulator.Confirmer.Information (Simulator.Catalog.GetStringFmt("Transfertable connected"));
                             GoToTarget = true;
-                            TargetX = Offsets[ConnectedTarget];
+                            TargetOffset = Offsets[ConnectedTarget];
                         }
                     }
                  }
@@ -356,14 +373,14 @@ public override void Update()
                     Connected = false;
                     if (ConnectedTarget != -1)
                     {
-                        if (XPos - Offsets[ConnectedTarget] < 0.005)
+                        if (OffsetPos - Offsets[ConnectedTarget] < 0.005)
                         {
                             Connected = true;
                             Reverse = false;
                             ConnectedTrackEnd = ConnectedTarget;
                             Simulator.Confirmer.Information(Simulator.Catalog.GetStringFmt("Transfertable connected"));
                             GoToTarget = true;
-                            TargetX = Offsets[ConnectedTarget];
+                            TargetOffset = Offsets[ConnectedTarget];
                         }
                     }
                 }

Source/RunActivity/Viewer3D/Shapes.cs

@@ -1256,7 +1256,7 @@ public TransfertableShape(Viewer viewer, string path, WorldPosition initialPosit
             : base(viewer, path, initialPosition, flags)
         {
             Transfertable = transfertable;
-            AnimationKey = (Transfertable.XPos - Transfertable.CenterOffset.X)/ Transfertable.Width * SharedShape.Animations[0].FrameCount;
+            AnimationKey = (Transfertable.OffsetPos - Transfertable.CenterOffsetComponent) / Transfertable.Span * SharedShape.Animations[0].FrameCount;
             for (var imatrix = 0; imatrix < SharedShape.Matrices.Length; ++imatrix)
             {
                 if (SharedShape.MatrixNames[imatrix].ToLower() == transfertable.Animations[0].ToLower())
@@ -1299,7 +1299,7 @@ public override void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
         {
             if (Transfertable.GoToTarget)
             {
-                AnimationKey = (Transfertable.TargetX - Transfertable.CenterOffset.X) / Transfertable.Width * SharedShape.Animations[0].FrameCount;
+                AnimationKey = (Transfertable.TargetOffset - Transfertable.CenterOffsetComponent) / Transfertable.Span * SharedShape.Animations[0].FrameCount;
             }
 
             else if (Transfertable.Forward)
@@ -1313,7 +1313,7 @@ public override void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
             if (AnimationKey > SharedShape.Animations[0].FrameCount) AnimationKey = SharedShape.Animations[0].FrameCount;
             if (AnimationKey < 0) AnimationKey = 0;
 
-            Transfertable.XPos = AnimationKey / SharedShape.Animations[0].FrameCount * Transfertable.Width + Transfertable.CenterOffset.X;
+            Transfertable.OffsetPos = AnimationKey / SharedShape.Animations[0].FrameCount * Transfertable.Span + Transfertable.CenterOffsetComponent;
 
             if ((Transfertable.Forward || Transfertable.Reverse) && !Translating)
             {