Merge pull request #863 from Csantucci/alternate-3DCab-preset-viewpoints

Alternate preset 3D cabviewpoints

Author: Csantucci

Source/Documentation/Manual/cabs.rst

@@ -1154,6 +1154,40 @@ Development Rules
         StartDirection ( 12 0 0 )
     )
 
+- If also a rear cab is present, a second ``ORTS3DCab`` has to be added, 
+  as follows::
+
+     ORTS3DCab(
+        ORTS3DCabFile ( Cab.s )
+        ORTS3DCabHeadPos ( 0.9 2.4 5.2 )
+        RotationLimit ( 40 60 0 )
+        StartDirection ( 12 180 0 )
+    )
+
+- Alternate 3D cab viewpoints may be added, as in the example here below::
+
+      ORTSAlternate3DCabViewPoints
+                         (
+        ORTSAlternate3DCabViewPoint(
+           ORTS3DCabFile ( Cab.s )
+           ORTS3DCabHeadPos ( 0.9 2.4 5.2 )
+           RotationLimit ( 40 60 0 )
+           StartDirection ( 12 0 0 )
+                        )
+        ORTSAlternate3DCabViewPoint(
+          ORTS3DCabFile ( Cab.s )
+          ORTS3DCabHeadPos ( -0.8 2.4 5.2 )
+          RotationLimit ( 40 60 0 )
+          StartDirection ( 12 30 0 )
+                        )
+                        )
+
+
+-  To switch between alternate cab viewpoints ``Ctrl-Shift-1`` must be pressed.
+   If there aren't alternate viewpoints defined, and if there is no rear cab, 
+   pressing ``Ctrl-Shift-1`` toggles between the base viewpoint and a symmetrical 
+   one on the longitudinal axis.
+
 .. index::
    single: EXTERNALWIPERS
    single: AMMETER

Source/ORTS.Common/Input/UserCommand.cs

@@ -77,6 +77,7 @@ public enum UserCommand
 
         [GetString("Camera Cab")] CameraCab,
         [GetString("Camera Change Passenger Viewpoint")] CameraChangePassengerViewPoint,
+        [GetString("Camera Change 3DCab Viewpoint")] CameraChange3DCabViewPoint,
         [GetString("Camera Toggle 3D Cab")] CameraToggleThreeDimensionalCab,
         [GetString("Camera Toggle Show Cab")] CameraToggleShowCab,
         [GetString("Camera Toggle Letterbox Cab")] CameraToggleLetterboxCab,

Source/ORTS.Settings/InputSettings.cs

@@ -332,6 +332,7 @@ static void InitializeCommands(UserCommandInput[] Commands)
             Commands[(int)UserCommand.CameraScrollLeft] = new UserCommandModifiableKeyInput(0x4B, KeyModifiers.Alt);
             Commands[(int)UserCommand.CameraScrollRight] = new UserCommandModifiableKeyInput(0x4D, KeyModifiers.Alt);
             Commands[(int)UserCommand.CameraChangePassengerViewPoint] = new UserCommandKeyInput(0x06, KeyModifiers.Shift);
+            Commands[(int)UserCommand.CameraChange3DCabViewPoint] = new UserCommandKeyInput(0x02, KeyModifiers.Control | KeyModifiers.Shift);
             Commands[(int)UserCommand.CameraToggleLetterboxCab] = new UserCommandKeyInput(0x02, KeyModifiers.Control);
             Commands[(int)UserCommand.CameraToggleShowCab] = new UserCommandKeyInput(0x02, KeyModifiers.Shift);
             Commands[(int)UserCommand.CameraTrackside] = new UserCommandKeyInput(0x05);

Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs

@@ -1512,6 +1512,13 @@ public virtual void Parse(string lowercasetoken, STFReader stf)
                     }
                     else stf.SkipRestOfBlock();
                     break;
+                case "wagon(ortsalternate3dcabviewpoints": // accepted only if there is already a 3D cabview
+                    if (Cab3DShapeFileName != null)
+                    {
+                        ParseAlternate3DCabViewPoints(stf);
+                    }
+                    else stf.SkipRestOfBlock();
+                    break;
                 default:
                     if (MSTSBrakeSystem != null)
                         MSTSBrakeSystem.Parse(lowercasetoken, stf);
@@ -1752,6 +1759,15 @@ protected void ParseAlternatePassengerViewPoints(STFReader stf)
             });
         }
 
+        // parses additional 3Dcab viewpoints, if any
+        protected void ParseAlternate3DCabViewPoints(STFReader stf)
+        {
+            stf.MustMatch("(");
+            stf.ParseBlock(new[] {
+                new STFReader.TokenProcessor("ortsalternate3dcabviewpoint", ()=>{ Parse3DCab(stf); }),
+            });
+        }
+
         public static float ParseFloat(string token)
         {   // is there a better way to ignore any suffix?
             while (token.Length > 0)

Source/Orts.Simulation/Simulation/RollingStocks/TrainCar.cs

@@ -2291,8 +2291,9 @@ public bool HasRear3DCab
             {
                 var loco = this as MSTSLocomotive;
                 var i = (int)CabViewType.Rear;
-                if (loco == null || loco.CabView3D == null) return false;
-                return (loco.CabView3D.ViewPointList.Count > i);
+                if (loco == null || loco.CabView3D == null || loco.CabView3D.ViewPointList.Count <= i) return false;
+                var cabViewAngle = loco.CabView3D.ViewPointList[i].StartDirection.Y;
+                return ((cabViewAngle >= 90 && cabViewAngle <= 270) || (cabViewAngle <= -90 && cabViewAngle >= -270));
             }
         }
 

Source/RunActivity/Viewer3D/Cameras.cs

@@ -1758,6 +1758,12 @@ public override void Reset()
             XRadians = StartViewPointRotationXRadians;
             YRadians = StartViewPointRotationYRadians;
         }
+
+        public void SwitchSideCameraCar(TrainCar car)
+        {
+            attachedLocation.X = -attachedLocation.X;
+            RotationYRadians = -RotationYRadians;
+        }
     }
 
     public class PassengerCamera : InsideThreeDimCamera
@@ -1814,12 +1820,6 @@ public override void HandleUserInput(ElapsedTime elapsedTime)
                 new CameraChangePassengerViewPointCommand(Viewer.Log);
         }
 
-        public void SwitchSideCameraCar(TrainCar car)
-        {
-            attachedLocation.X = -attachedLocation.X;
-            RotationYRadians = -RotationYRadians;
-        }
-
         public void ChangePassengerViewPoint(TrainCar car)
         {
             ActViewPoint++;
@@ -1890,7 +1890,7 @@ public void ChangeCab(TrainCar newCar)
                 var mstsLocomotive = newCar as MSTSLocomotive;
                 if (PrevCabWasRear != mstsLocomotive.UsingRearCab)
                     RotationYRadians += MathHelper.Pi;
-                ActViewPoint = mstsLocomotive.UsingRearCab ? 1 : 0;
+                ActViewPoint = mstsLocomotive.UsingRearCab && mstsLocomotive.HasFront3DCab ? 1 : 0;
                 PrevCabWasRear = mstsLocomotive.UsingRearCab;
                 SetCameraCar(newCar);
             }
@@ -1925,6 +1925,20 @@ public override bool IsUnderground
                 return attachedCar.WorldPosition.Location.Y + TerrainAltitudeMargin < elevationAtCameraTarget || attachedCar.CarTunnelData.LengthMOfTunnelAheadFront > 0;
             }
         }
+
+        public override void HandleUserInput(ElapsedTime elapsedTime)
+        {
+            base.HandleUserInput(elapsedTime);
+            if (UserInput.IsPressed(UserCommand.CameraChange3DCabViewPoint))
+                new CameraChange3DCabViewPointCommand(Viewer.Log);
+        }
+
+        public void Change3DCabViewPoint(TrainCar car)
+        {
+            ActViewPoint++;
+            if (ActViewPoint >= car.CabViewpoints.Count) ActViewPoint = 0;
+            SetCameraCar(car);
+        }
     }
 
     public class HeadOutCamera : NonTrackingCamera

Source/RunActivity/Viewer3D/Commands.cs

@@ -947,6 +947,24 @@ public override void Redo()
         }
     }
 
+    [Serializable()]
+    public sealed class CameraChange3DCabViewPointCommand : UseCameraCommand
+    {
+
+        public CameraChange3DCabViewPointCommand(CommandLog log)
+            : base(log)
+        {
+            Redo();
+        }
+
+        public override void Redo()
+        {
+            if (Receiver.Camera.AttachedCar.CabViewpoints.Count == 1)
+                Receiver.ThreeDimCabCamera.SwitchSideCameraCar(Receiver.Camera.AttachedCar);
+            else Receiver.ThreeDimCabCamera.Change3DCabViewPoint(Receiver.Camera.AttachedCar);
+            // Report();
+        }
+    }
     [Serializable()]
     public sealed class ToggleBrowseBackwardsCommand : UseCameraCommand
     {

Source/RunActivity/Viewer3D/Viewer.cs

@@ -121,7 +121,7 @@ public class Viewer
         /// <summary>
         /// Camera #1, 3D cab. Swaps with <see cref="CabCamera"/> with Alt+1.
         /// </summary>
-        private readonly ThreeDimCabCamera ThreeDimCabCamera;
+        public readonly ThreeDimCabCamera ThreeDimCabCamera;
         public HeadOutCamera HeadOutForwardCamera { get; private set; } // Camera 1+Up
         public HeadOutCamera HeadOutBackCamera { get; private set; } // Camera 2+Down
         public TrackingCamera FrontCamera { get; private set; } // Camera 2