Merge remote-tracking branch 'upstream/master' into menu-options01

Author: Chris Jakeman

Source/Documentation/Manual/cabs.rst

@@ -527,6 +527,15 @@ if e.g. the wiper moves from left to right and back, only the frames related
 to the motion from left to right have to be included. For the reverse 
 motion the same frames are used from last to first. SwitchVal can vary from 0 to 1.
 
+Control Labels
+--------------
+
+The string appearing on the screen when the mouse browses over a command control 
+can be customized with following line, to be added within the control block in the 
+.cvf file::
+
+   ORTSLabel ( "string" )
+   
 Multiple screen pages on displays
 ---------------------------------
 

Source/Documentation/Manual/physics.rst

@@ -160,11 +160,17 @@ however if the modeler desires greater accuracy the following parameters can be
 WAG/ENG file in the wagon section:
 
 ``ORTSLengthBogieCentre`` - length between bogie centres.
-``ORTSLengthCarBody`` - Length between car ends.
+
+``ORTSLengthCarBody`` - Length between car ends (typically measured between the coupler pivot points).
+
 ``ORTSLengthCouplerFace`` - length between coupler faces.
 
-``ORTSNumAxles`` - number of axles on the car.
-``ORTSNumBogies`` - number of bogies on the car.
+``ORTSNumberAxles`` - number of axles on the car.
+
+``ORTSNumberDriveAxles`` - number of driven axles on the locomotive. NB: Total axles on locomotive will be 
+``ORTSNumberAxles`` + ``ORTSNumberDriveAxles``.
+
+``ORTSNumberBogies`` - number of bogies on the car.
 
 .. _physics-adhesion:
 

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -406,6 +406,7 @@ public class CabViewControl
 
         public double OldValue;
         public string ACEFile = "";
+        public string Label = "";
 
         public int Display;
         public List<string> Screens;
@@ -607,6 +608,11 @@ public CVCDial(STFReader stf, string basepath)
                     ToDegree = stf.ReadFloat(STFReader.UNITS.None, null);
                     stf.SkipRestOfBlock();
                 }),
+                new STFReader.TokenProcessor("ortslabel", ()=>{
+                    stf.MustMatch("(");
+                    Label = stf.ReadString();
+                    stf.SkipRestOfBlock();
+                }),
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
@@ -696,6 +702,11 @@ public CVCGauge(STFReader stf, string basepath)
                     }
                 }),
                 new STFReader.TokenProcessor("ortsangle", () =>{ Rotation = ParseRotation(stf); }),
+                new STFReader.TokenProcessor("ortslabel", ()=>{
+                    stf.MustMatch("(");
+                    Label = stf.ReadString();
+                    stf.SkipRestOfBlock();
+                }),
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
@@ -822,6 +833,11 @@ public CVCDigital(STFReader stf, string basepath)
                 }),
                 new STFReader.TokenProcessor("ortsfont", ()=>{ParseFont(stf); }),
                 new STFReader.TokenProcessor("ortsangle", () => {Rotation = ParseRotation(stf); }),
+                new STFReader.TokenProcessor("ortslabel", ()=>{
+                    stf.MustMatch("(");
+                    Label = stf.ReadString();
+                    stf.SkipRestOfBlock();
+                }),
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortscabviewpoint", ()=>{ParseCabViewpoint(stf); }),
@@ -1066,6 +1082,11 @@ public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
                             _ValuesRead++;
                         }
                     }),
+                new STFReader.TokenProcessor("ortslabel", ()=>{
+                    stf.MustMatch("(");
+                    Label = stf.ReadString();
+                    stf.SkipRestOfBlock();
+                }),
                 new STFReader.TokenProcessor("ortsdisplay", ()=>{ParseDisplay(stf); }),
                 new STFReader.TokenProcessor("ortsscreenpage", () => {ParseScreen(stf); }),
                 new STFReader.TokenProcessor("ortsnewscreenpage", () => {ParseNewScreen(stf); }),

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

@@ -5208,7 +5208,7 @@ public virtual float GetDataOf(CabViewControl cvc)
                     break;
 
                 case CABViewControlTypes.ORTS_BATTERY_SWITCH_COMMAND_BUTTON_OPEN:
-                    data = LocomotivePowerSupply.BatterySwitch.CommandButtonOn ? 1 : 0;
+                    data = LocomotivePowerSupply.BatterySwitch.CommandButtonOff ? 1 : 0;
                     break;
 
                 case CABViewControlTypes.ORTS_BATTERY_SWITCH_ON:

Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs

@@ -571,7 +571,7 @@ public float TenderCoalMassKG              // Decreased by firing and increased
         float DisplayCriticalSpeedTractiveEffortLbf;  // Display power value @ speed of piston
         float absStartTractiveEffortN = 0.0f;      // Record starting tractive effort
         float TractiveEffortLbsF;           // Current sim calculated tractive effort
-        const float TractiveEffortFactor = 0.85f;  // factor for calculating Theoretical Tractive Effort for non-geared locomotives
+        float TractiveEffortFactor = 0.85f;  // factor for calculating Theoretical Tractive Effort for non-geared locomotives
         float GearedTractiveEffortFactor = 0.7f;  // factor for calculating Theoretical Tractive Effort for geared locomotives
         float NeutralGearedDavisAN; // Davis A value adjusted for neutral gearing
         const float DavisMechanicalResistanceFactor = 20.0f;
@@ -1254,6 +1254,13 @@ public override void Initialize()
 
             // ******************  Test Locomotive and Gearing type *********************** 
 
+            // if the maximum cutoff for the locomotive is less then the default value, then decrease it so that tractive effort is not excessive. 
+            // At some future stage it may be worthwhile to add an extra parameter to the ENG file to allow user setting.
+            if (CutoffController.MaximumValue < TractiveEffortFactor)
+            {
+                TractiveEffortFactor = CutoffController.MaximumValue;
+            }
+
             if (SteamEngineType == SteamEngineTypes.Compound)
             {
                 //  Initialise Compound locomotive

Source/RunActivity/Viewer3D/MSTSSky.cs

@@ -68,11 +68,8 @@ public class MSTSSkyDrawer
 
         public Orts.Viewer3D.SkyViewer.Date date;
 
-        // Size of the sun- and moon-position lookup table arrays.
-        // Must be an integral divisor of 1440 (which is the number of minutes in a day).
-        private int maxSteps = 72;
-        private double mstsskyoldClockTime;
-        private int step1, step2;
+        private SkySteps skySteps = new SkySteps();
+
         // Phase of the moon
         public int mstsskymoonPhase;
         // Wind speed and direction
@@ -128,11 +125,11 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
             {
                 // First time around, initialize the following items:
                 mstsskyworldLoc = new WorldLatLon();
-                mstsskyoldClockTime = MSTSSkyViewer.Simulator.ClockTime % 86400;
-                while (mstsskyoldClockTime < 0) mstsskyoldClockTime += 86400;
-                step1 = step2 = (int)(mstsskyoldClockTime / 1200);
-                step2 = step2 < maxSteps - 1 ? step2 + 1 : 0; // limit to max. steps in case activity starts near midnight
-                // Get the current latitude and longitude coordinates
+                skySteps.OldClockTime = MSTSSkyViewer.Simulator.ClockTime % 86400;
+                while (skySteps.OldClockTime < 0) skySteps.OldClockTime += 86400;
+                skySteps.Step1 = skySteps.Step2 = (int)(skySteps.OldClockTime / 1200);
+                skySteps.Step2 = skySteps.Step2 < skySteps.MaxSteps - 1 ? skySteps.Step2 + 1 : 0; // limit to max. steps in case activity starts near midnight
+                                                                                                  // Get the current latitude and longitude coordinates
                 mstsskyworldLoc.ConvertWTC(MSTSSkyViewer.Camera.TileX, MSTSSkyViewer.Camera.TileZ, MSTSSkyViewer.Camera.Location, ref mstsskylatitude, ref mstsskylongitude);
                 if (mstsskyseasonType != (int)MSTSSkyViewer.Simulator.Season)
                 {
@@ -144,10 +141,10 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
                     date.year = 2017;
                 }
                 // Fill in the sun- and moon-position lookup tables
-                for (int i = 0; i < maxSteps; i++)
+                for (int i = 0; i < skySteps.MaxSteps; i++)
                 {
-                    mstsskysolarPosArray[i] = SunMoonPos.SolarAngle(mstsskylatitude, mstsskylongitude, ((float)i / maxSteps), date);
-                    mstsskylunarPosArray[i] = SunMoonPos.LunarAngle(mstsskylatitude, mstsskylongitude, ((float)i / maxSteps), date);
+                    mstsskysolarPosArray[i] = SunMoonPos.SolarAngle(mstsskylatitude, mstsskylongitude, ((float)i / skySteps.MaxSteps), date);
+                    mstsskylunarPosArray[i] = SunMoonPos.LunarAngle(mstsskylatitude, mstsskylongitude, ((float)i / skySteps.MaxSteps), date);
                 }
                 // Phase of the moon is generated at random
                 mstsskymoonPhase = Viewer.Random.Next(8);
@@ -209,58 +206,14 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
                 }
             }
 
-            ////////////////////////////////////////////////////////////////////
-
-            // Current solar and lunar position are calculated by interpolation in the lookup arrays.
-            // Using the Lerp() function, so need to calculate the in-between differential
-            float diff = (float)(MSTSSkyViewer.Simulator.ClockTime - mstsskyoldClockTime) / 1200;
-            // The rest of this increments/decrements the array indices and checks for overshoot/undershoot.
-            if (MSTSSkyViewer.Simulator.ClockTime >= (mstsskyoldClockTime + 1200)) // Plus key, or normal forward in time
-            {
-                step1++;
-                step2++;
-                mstsskyoldClockTime = MSTSSkyViewer.Simulator.ClockTime;
-                diff = 0;
-                if (step2 >= maxSteps) // Midnight.
-                {
-                    step2 = 0;
-                }
-                if (step1 >= maxSteps) // Midnight.
-                {
-                    step1 = 0;
-                }
-            }
-            if (MSTSSkyViewer.Simulator.ClockTime <= (mstsskyoldClockTime - 1200)) // Minus key
-            {
-                step1--;
-                step2--;
-                mstsskyoldClockTime = MSTSSkyViewer.Simulator.ClockTime;
-                diff = 0;
-                if (step1 < 0) // Midnight.
-                {
-                    step1 = maxSteps - 1;
-                }
-                if (step2 < 0) // Midnight.
-                {
-                    step2 = maxSteps - 1;
-                }
-            }
-
-
-            mstsskysolarDirection.X = MathHelper.Lerp(mstsskysolarPosArray[step1].X, mstsskysolarPosArray[step2].X, diff);
-            mstsskysolarDirection.Y = MathHelper.Lerp(mstsskysolarPosArray[step1].Y, mstsskysolarPosArray[step2].Y, diff);
-            mstsskysolarDirection.Z = MathHelper.Lerp(mstsskysolarPosArray[step1].Z, mstsskysolarPosArray[step2].Z, diff);
-            mstsskylunarDirection.X = MathHelper.Lerp(mstsskylunarPosArray[step1].X, mstsskylunarPosArray[step2].X, diff);
-            mstsskylunarDirection.Y = MathHelper.Lerp(mstsskylunarPosArray[step1].Y, mstsskylunarPosArray[step2].Y, diff);
-            mstsskylunarDirection.Z = MathHelper.Lerp(mstsskylunarPosArray[step1].Z, mstsskylunarPosArray[step2].Z, diff);
+            skySteps.SetSunAndMoonDirection(ref mstsskysolarDirection, ref mstsskylunarDirection, ref mstsskysolarPosArray, ref mstsskylunarPosArray,
+                MSTSSkyViewer.Simulator.ClockTime);
 
             frame.AddPrimitive(MSTSSkyMaterial, MSTSSkyMesh, RenderPrimitiveGroup.Sky, ref XNASkyWorldLocation);
         }
 
         public void LoadPrep()
         {
-
-
             mstsskyworldLoc = new WorldLatLon();
             // Get the current latitude and longitude coordinates
             mstsskyworldLoc.ConvertWTC(MSTSSkyViewer.Camera.TileX, MSTSSkyViewer.Camera.TileZ, MSTSSkyViewer.Camera.Location, ref mstsskylatitude, ref mstsskylongitude);
@@ -274,7 +227,6 @@ public void LoadPrep()
             mstsskyworldLoc = null;
             mstsskylatitude = 0;
             mstsskylongitude = 0;
-
         }
 
         [CallOnThread("Loader")]

Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs

@@ -1579,7 +1579,7 @@ public interface ICabViewMouseControlRenderer
         bool IsMouseWithin();
         void HandleUserInput();
         string GetControlName();
-
+        string ControlLabel { get; }
     }
 
     /// <summary>
@@ -2215,6 +2215,8 @@ public string GetControlName()
             return (Locomotive as MSTSLocomotive).TrainControlSystem.GetDisplayString(GetControlType().ToString());
         }
 
+        public string ControlLabel => Control.Label;
+
         /// <summary>
         /// Handles cabview mouse events, and changes the corresponding locomotive control values.
         /// </summary>

Source/RunActivity/Viewer3D/RollingStock/SubSystems/ETCS/DriverMachineInterface.cs

@@ -856,7 +856,7 @@ public string GetControlName()
             }
             return "";
         }
-
+        public string ControlLabel => GetControlName();
         public override void Draw(GraphicsDevice graphicsDevice)
         {
             DMI.Draw(ControlView.SpriteBatch, new Point(DrawPosition.X, DrawPosition.Y));

Source/RunActivity/Viewer3D/Scenery.cs

@@ -463,10 +463,10 @@ public WorldFile(Viewer viewer, int tileX, int tileZ, bool visible)
                         if (Program.Simulator.CarSpawnerLists != null && ((CarSpawnerObj)worldObject).ListName != null)
                         {
                             ((CarSpawnerObj)worldObject).CarSpawnerListIdx = Program.Simulator.CarSpawnerLists.FindIndex(x => x.ListName == ((CarSpawnerObj)worldObject).ListName);
-                            if (((CarSpawnerObj)worldObject).CarSpawnerListIdx < 0 || ((CarSpawnerObj)worldObject).CarSpawnerListIdx > Program.Simulator.CarSpawnerLists.Count-1) 
+                            if (((CarSpawnerObj)worldObject).CarSpawnerListIdx < 0 || ((CarSpawnerObj)worldObject).CarSpawnerListIdx > Program.Simulator.CarSpawnerLists.Count - 1)
                                 ((CarSpawnerObj)worldObject).CarSpawnerListIdx = 0;
                         }
-                        else 
+                        else
                             ((CarSpawnerObj)worldObject).CarSpawnerListIdx = 0;
                         carSpawners.Add(new RoadCarSpawner(viewer, worldMatrix, (CarSpawnerObj)worldObject));
                     }
@@ -480,9 +480,13 @@ public WorldFile(Viewer viewer, int tileX, int tileZ, bool visible)
                     }
                     else if (worldObject.GetType() == typeof(StaticObj))
                     {
-                        //          preTestShape for lookup if it is an animated clock shape with subobjects named as clock hands 
+                        // preTestShape for lookup if it is an animated clock shape with subobjects named as clock hands 
                         StaticShape preTestShape = (new StaticShape(viewer, shapeFilePath, worldMatrix, shadowCaster ? ShapeFlags.ShadowCaster : ShapeFlags.None));
-                        var animNodes = preTestShape.SharedShape.Animations?[0]?.anim_nodes ?? new List<anim_node>();
+
+                        // FirstOrDefault() checks for "animations( 0 )" as this is a valid entry in *.s files
+                        // and is included by MSTSexporter for Blender 2.8+ Release V4.0 or older
+                        var animNodes = preTestShape.SharedShape.Animations?.FirstOrDefault()?.anim_nodes ?? new List<anim_node>();
+
                         var isAnimatedClock = animNodes.Exists(node => Regex.IsMatch(node.Name, @"^orts_[hmsc]hand_clock", RegexOptions.IgnoreCase));
                         if (isAnimatedClock)
                         {