Removed option Cab 2D Stretch.

Author: Chris Jakeman

Source/Documentation/Manual/driving.rst

@@ -25,6 +25,33 @@ your train will be in motion or stopped. To look around in the simulation, you
 can select different views using the keyboard, as described in 
 :ref:`Changing the View <driving-changing-view>`.
 
+Cab Letter-Boxing
+----------------
+
+OR manages not only cab interiors using 2D images in a MSTS-compatible
+way, but also supports 3D models. Most 2D cab images follow MSTS practice,
+being 1024 x 768 pixels to suit monitors with a 4:3 aspect ratio.
+
+.. image:: images/options-2dstretch_1.png
+
+So, the problem arises -- how to display these 4:3 cabs on a 16:9 or 16:10
+monitor?
+
+One possibility is to enlarge these images to fill the width of wider monitors, 
+as shown in the image below.
+
+In doing so, we lose a portion from the top and bottom of the image. 
+You can use the Up and Down Arrow keys to pan and reveal these missing portions.
+
+.. image:: images/options-2dstretch_2.png
+
+Instead of enlarging the image, OR can also 'letterbox' it by showing the full height
+and filling the missing space with black bars. 
+You can activate this mode in-game by pressing Ctrl+1.
+
+.. image:: images/options-2dstretch_3.png
+
+
 Open Rails Driving Controls
 ===========================
 

Source/Documentation/Manual/images/options-video.png

@@ -283,41 +283,6 @@ may see stuttering or image "tearing". To prevent this, either turn off
 the VSync option or reduce the values for video options such as view 
 distance, anti-aliasing, or world object density.
 
-.. _options-cab-stretch:
-
-% Cab 2D stretch
-----------------
-
-OR manages not only cab interiors using 2D images in a MSTS-compatible
-way, but also supports 3D models. Most 2D cab images follow MSTS practice,
-being 1024 x 768 pixels to suit monitors with a 4:3 aspect ratio.
-
-So, the problem arises -- how to display these 4:3 cabs on a 16:9 or 16:10
-monitor?
-
-One possibility is to stretch these images horizontally to match other
-aspect ratios, as shown in the image below.
-
-.. image:: images/options-2dstretch_1.png
-
-To respect the proportions however, by default OR does no stretching and
-shows the full width of the cab interior, thus losing a portion from the
-top and bottom of the image. You can use the Up and Down Arrow keys to pan
-and reveal these missing portions.
-
-Therefore the setting for % Cab 2D Stretch has a default value of 0
-providing no stretching and a maximum value of 100 which stretches the
-picture so as to cover the complete display. Intermediate values provide a
-blend of panning and stretching.
-
-.. image:: images/options-2dstretch_2.png
-
-OR can also pillarbox or letterbox the cab by filling the missing space with 
-black bars. You can activate this mode in-game by pressing Ctrl+1. It overrides 
-any stretching.
-
-.. image:: images/options-2dstretch_3.png
-
 Viewing distance
 ----------------
 

Source/Documentation/Manual/options.rst

@@ -167,7 +167,6 @@ public OptionsForm(UserSettings settings, UpdateManager updateManager, bool init
             checkModelInstancing.Checked = Settings.ModelInstancing;
             checkWire.Checked = Settings.Wire;
             checkVerticalSync.Checked = Settings.VerticalSync;
-            numericCab2DStretch.Value = Settings.Cab2DStretch;
             numericViewingDistance.Value = Settings.ViewingDistance;
             checkDistantMountains.Checked = Settings.DistantMountains;
             labelDistantMountainsViewingDistance.Enabled = checkDistantMountains.Checked;
@@ -457,7 +456,6 @@ void buttonOK_Click(object sender, EventArgs e)
             Settings.ModelInstancing = checkModelInstancing.Checked;
             Settings.Wire = checkWire.Checked;
             Settings.VerticalSync = checkVerticalSync.Checked;
-            Settings.Cab2DStretch = (int)numericCab2DStretch.Value;
             Settings.ViewingDistance = (int)numericViewingDistance.Value;
             Settings.DistantMountains = checkDistantMountains.Checked;
             Settings.DistantMountainsViewingDistance = (int)numericDistantMountainsViewingDistance.Value * 1000;

Source/Menu/Options.Designer.cs

@@ -126,4 +126,7 @@
   <metadata name="bindingSourceContent.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>114, 17</value>
   </metadata>
+  <metadata name="toolTip1.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>17, 17</value>
+  </metadata>
 </root>

Source/Menu/Options.cs

@@ -206,8 +206,6 @@ public enum DirectXFeature
         public bool Wire { get; set; }
         [Default(false)]
         public bool VerticalSync { get; set; }
-        [Default(0)]
-        public int Cab2DStretch { get; set; }
         [Default(2000)]
         public int ViewingDistance { get; set; }
         [Default(true)]

Source/Menu/Options.resx

@@ -2040,7 +2040,7 @@ public void Initialize()
                 float fovFactor = 1f - Math.Max((float)Viewer.CabXLetterboxPixels / Viewer.DisplaySize.X, (float)Viewer.CabYLetterboxPixels / Viewer.DisplaySize.Y);
                 FieldOfView = MathHelper.ToDegrees((float)(2 * Math.Atan(fovFactor * Math.Tan(MathHelper.ToRadians(Viewer.Settings.ViewingFOV / 2)))));
             }
-            else if (Viewer.Settings.Cab2DStretch == 0 && Viewer.CabExceedsDisplayHorizontally <= 0)
+            else if (Viewer.CabExceedsDisplayHorizontally <= 0)
             {
                 // We must modify FOV to get correct lookout
                     FieldOfView = MathHelper.ToDegrees((float)(2 * Math.Atan((float)Viewer.DisplaySize.Y / Viewer.DisplaySize.X / Viewer.CabTextureInverseRatio * Math.Tan(MathHelper.ToRadians(Viewer.Settings.ViewingFOV / 2)))));

Source/ORTS.Settings/UserSettings.cs

@@ -202,13 +202,9 @@ enum VisibilityState
 
         // MSTS cab views are images with aspect ratio 4:3.
         // OR can use cab views with other aspect ratios where these are available.
-        // On screen with other aspect ratios (e.g. 16:9), three approaches are possible:
-        //   1) stretch the width to fit the screen. This gives flattened controls, most noticeable with round dials.
-        //   2) clip the image losing a slice off top and bottom.
-        //   3) letterbox the image by drawing black bars in the unfilled spaces.
-        // Setting.Cab2DStretch controls the amount of stretch and clip. 0 is entirely clipped and 100 is entirely stretched.
-        // No difference is seen on screens with 4:3 aspect ratio.
-        // This adjustment assumes that the cab view is 4:3. Where the cab view matches the aspect ratio of the screen, use an adjustment of 100.
+        // On screen with other aspect ratios (e.g. 16:9), two approaches are possible:
+        //   1) clip the image losing a slice off top and bottom. Use arrow keys to bring these slices into view.
+        //   2) letterbox the image by drawing black bars in the unfilled spaces.
         public int CabHeightPixels { get; private set; }
         public int CabWidthPixels { get; private set; }
         public int CabYOffsetPixels { get; set; } // Note: Always -ve. Without it, the cab view is fixed to the top of the screen. -ve values pull it up the screen.
@@ -701,11 +697,9 @@ public void AdjustCabHeight(int windowWidth, int windowHeight)
             // MSTS cab views are designed for 4:3 aspect ratio. This is the default. However a check is done with the actual
             // cabview texture. If this has a different aspect ratio, that one is considered
             // For wider screens (e.g. 16:9), the height of the cab view before adjustment exceeds the height of the display.
-            // The user can decide how much of this excess to keep. Setting of 0 keeps all the excess and 100 keeps none.
 
-            // <CSComment> If the aspect ratio of the viewing window is greater than the aspect ratio of the cabview texture file
-            // it is either possible to stretch the cabview texture file or to leave the proportions unaltered and to vertically pan
-            // the screen
+            // <CSComment> If the aspect ratio of the viewing window is greater than the aspect ratio of the cabview texture file,
+            // it is possible to vertically pan the screen.
             if (CabCamera.IsAvailable)
             {
                 var i = ((PlayerLocomotive as MSTSLocomotive).UsingRearCab) ? 1 : 0;
@@ -735,7 +729,7 @@ public void AdjustCabHeight(int windowWidth, int windowHeight)
                 else if (windowInverseRatio < CabTextureInverseRatio)
                 {
                     // screen is wide-screen, so can choose between vertical scroll or horizontal stretch
-                    CabExceedsDisplay = (int)((unstretchedCabHeightPixels - windowHeight) * ((100 - Settings.Cab2DStretch) / 100f));
+                    CabExceedsDisplay = (int)(unstretchedCabHeightPixels - windowHeight);
                     CabExceedsDisplayHorizontally = 0;
                 }
                 else