Automatic merge of T1.5.1-1072-g3c01d62002 and 23 pull requests

- Pull request #799 at dfc715e: Consolidated wind simulation
- Pull request #839 at d00beb9: First phase of https://blueprints.launchpad.net/or/+spec/additional-cruise-control-parameters
- Pull request #876 at f92de76: docs: add source for documents previously on website to source Documentation folder
- Pull request #882 at 8f695a4: Blueprint/train car operations UI window
- Pull request #885 at e267870: feat: Add notifications to Menu
- Pull request #891 at 9a1d6b2: Auto save
- Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH
- Pull request #896 at 5866028: First implementation of https://blueprints.launchpad.net/or/+spec/specific-sounds-for-ai-trains
- Pull request #900 at c27f32d: DMI updates
- Pull request #903 at 3e390b8: Downloading route content (Github, zip)
- Pull request #922 at a3bc9e7: Autopilot for timetable mode
- Pull request #946 at 91a03af: Advanced track sounds
- Pull request #952 at 8347095: Investigation - Pulsing graphics
- Pull request #953 at a519452: Fix Lights Crash on Corrupt Shapes
- Pull request #954 at 84c2f4b: Add Support for Multiple Track Profiles
- Pull request #959 at 2452cb0: Fix TrackViewer crash on big zoom value
- Pull request #962 at 46d0472: Fix pantographs on unpowered cars
- Pull request #963 at 2d5a67d: Fix dynamic brake force indicator
- Pull request #964 at b11c894: fix: Warning CA1417: Do not use the 'OutAttribute' for string parameter
- Pull request #965 at 7554f02: style: Renormalize line endings
- Pull request #966 at 6353e03: fix: Warning CS0618: 'string.Copy(string)' is obsolete
- Pull request #967 at a799e20: Fix AI Lights After Reversing Points
- Pull request #968 at 415aec7: Initial build of adding track section identifier for rack railway

Author: openrails-bot

Source/Orts.Formats.Msts/TrackSectionsFile.cs

@@ -206,6 +206,7 @@ public TrackShape(STFReader stf)
                 new STFReader.TokenProcessor("sectionidx", ()=>{ SectionIdxs[nextPath++] = new SectionIdx(stf); }),
                 new STFReader.TokenProcessor("tunnelshape", ()=>{ TunnelShape = stf.ReadBoolBlock(true); }),
                 new STFReader.TokenProcessor("roadshape", ()=>{ RoadShape = stf.ReadBoolBlock(true); }),
+                new STFReader.TokenProcessor("ortsrackshape", ()=>{ RackShape = stf.ReadBoolBlock(true); }),
             });
 			// TODO - this was removed since TrackShape( 183 ) is blank
 			//if( FileName == null )	throw( new STFError( stf, "Missing FileName" ) );
@@ -220,7 +221,7 @@ public TrackShape(STFReader stf)
 		public SectionIdx[] SectionIdxs;
         public bool TunnelShape;
         public bool RoadShape;
-
+		public bool RackShape;
 	}
 
 	public class TrackShapes: Dictionary<uint, TrackShape>

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

@@ -64,6 +64,7 @@
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
+using static Orts.Simulation.RollingStocks.MSTSSteamLocomotive;
 using Event = Orts.Common.Event;
 
 namespace Orts.Simulation.RollingStocks
@@ -104,6 +105,15 @@ public enum SoundState
             ContinuousSound
         }
 
+        public enum LocomotiveRailDriveTypes
+        {
+            Unknown,
+            Rack,
+            Adhesion, // defaults to adhesion
+        }
+
+        public LocomotiveRailDriveTypes LocomotiveRailDriveType;
+
         // simulation parameters
         public bool ManualHorn = false;
         public bool TCSHorn = false;
@@ -1199,6 +1209,19 @@ public override void Parse(string lowercasetoken, STFReader stf)
                     break;
                 case "engine(ortscruisecontrol": SetUpCruiseControl(stf); break;
                 case "engine(ortsmultipositioncontroller": SetUpMPC(stf); break;
+                case "engine(ortslocomotiveraildrivetype":
+                    stf.MustMatch("(");
+                    var locomotiveDriveType = stf.ReadString();
+                    try
+                    {
+                        LocomotiveRailDriveType = (LocomotiveRailDriveTypes)Enum.Parse(typeof(LocomotiveRailDriveTypes), locomotiveDriveType);
+                    }
+                    catch
+                    {
+                        if (Simulator.Settings.VerboseConfigurationMessages)
+                            STFException.TraceWarning(stf, "Assumed unknown fuel type " + locomotiveDriveType);
+                    }
+                    break;
                 default:
                     base.Parse(lowercasetoken, stf);
                     break;
@@ -1354,6 +1377,7 @@ public override void Copy(MSTSWagon copy)
             MultiPositionControllers = locoCopy.CloneMPC(this);
             OnLineCabRadio = locoCopy.OnLineCabRadio;
             OnLineCabRadioURL = locoCopy.OnLineCabRadioURL;
+            LocomotiveRailDriveType = locoCopy.LocomotiveRailDriveType;
         }
 
         /// <summary>
@@ -1560,6 +1584,15 @@ public override void Initialize()
                 IsSteamHeatFitted = true;
             }
 
+            // Type of rail drive selected
+            if (LocomotiveRailDriveType == LocomotiveRailDriveTypes.Unknown)
+            {
+                LocomotiveRailDriveType = LocomotiveRailDriveTypes.Adhesion;
+
+                if (Simulator.Settings.VerboseConfigurationMessages)
+                    Trace.TraceInformation("LocomotiveRailDriveType set to Default value of {0}", LocomotiveRailDriveType);
+            }
+
             SteamHeatPressureToTemperaturePSItoF = SteamTable.SteamHeatPressureToTemperatureInterpolatorPSItoF();
             SteamDensityPSItoLBpFT3 = SteamTable.SteamDensityInterpolatorPSItoLBpFT3();
             SteamHeatPSItoBTUpLB = SteamTable.SteamHeatInterpolatorPSItoBTUpLB();
@@ -2019,6 +2052,16 @@ public override void Update(float elapsedClockSeconds)
                 }
             }
 
+            // determine if this is an adhesion or rack locomotive
+            if (LocomotiveRailDriveType == LocomotiveRailDriveTypes.Rack)
+            {
+                foreach (var axle in LocomotiveAxles)
+                {
+                    axle.CogWheelFitted = true;
+                }
+            }
+
+
             var gearloco = this as MSTSDieselLocomotive;
 
             // Pass Gearbox commands

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerTransmissions/Axle.cs

@@ -20,17 +20,11 @@
 
 using System;
 using System.IO;
-using System.Collections;
 using System.Collections.Generic;
 using System.Diagnostics;
 using Microsoft.Xna.Framework;
 using ORTS.Common;
 using Orts.Parsers.Msts;
-using Orts.Simulation.RollingStocks.SubSystems.PowerTransmissions;
-using SharpDX.Direct2D1;
-using SharpDX.Direct3D9;
-using Orts.Formats.OR;
-using static Orts.Simulation.RollingStocks.SubSystems.PowerTransmissions.Axle;
 
 namespace Orts.Simulation.RollingStocks.SubSystems.PowerTransmissions
 {
@@ -709,6 +703,9 @@ public float TransmissionEfficiency
         /// </summary>
         public float TrainSpeedMpS;
 
+        public bool CogWheelFitted;
+        public bool IsRackRailway;
+
         /// <summary>
         /// Wheel slip indicator
         /// - is true when absolute value of SlipSpeedMpS is greater than WheelSlipThresholdMpS, otherwise is false
@@ -906,6 +903,10 @@ public void Parse(STFReader stf)
                         WheelWeightKg = stf.ReadFloatBlock(STFReader.UNITS.Mass, null);
                         AxleWeightN = 9.81f * WheelWeightKg;
                         break;
+                    case "cogwheel":
+                        CogWheelFitted = stf.ReadBoolBlock(false);
+                        Trace.TraceInformation("CogWheel - {0}", CogWheelFitted);
+                        break;
                     case "animatedparts":
                         foreach (var part in stf.ReadStringBlock("").ToUpper().Replace(" ", "").Split(','))
                         {
@@ -926,6 +927,7 @@ public void Copy(Axle other)
             InertiaKgm2 = other.InertiaKgm2;
             WheelWeightKg = other.WheelWeightKg;
             AxleWeightN = other.AxleWeightN;
+            CogWheelFitted = other.CogWheelFitted;
             AnimatedParts.Clear();
             AnimatedParts.AddRange(other.AnimatedParts);
         }
@@ -1144,6 +1146,34 @@ void Integrate(float elapsedClockSeconds)
         /// <param name="elapsedSeconds"></param>
         public virtual void Update(float elapsedSeconds)
         {
+            if (CogWheelFitted && IsRackRailway)
+            {
+                AxleSpeedMpS = TrainSpeedMpS;
+
+                motor?.Update(elapsedSeconds);
+
+                double axleInForceN = 0;
+                if (DriveType == AxleDriveType.ForceDriven)
+                    axleInForceN = DriveForceN * transmissionEfficiency;
+                else if (DriveType == AxleDriveType.MotorDriven)
+                    axleInForceN = motor.GetDevelopedTorqueNm(AxleSpeedMpS * transmissionRatio / WheelRadiusM) * transmissionEfficiency / WheelRadiusM;
+
+                double motionForceN = axleInForceN - dampingNs * (AxleSpeedMpS - TrainSpeedMpS); // Drive force + heat losses
+                double frictionForceN = BrakeRetardForceN + frictionN; // Dissipative forces: they will never increase wheel speed
+                double totalAxleForceN = motionForceN - Math.Sign(AxleSpeedMpS) * frictionForceN;
+
+                AxleForceN = (float)totalAxleForceN;
+                CompensatedAxleForceN = (float)motionForceN;
+
+                IsWheelSlip = IsWheelSlipWarning = HuDIsWheelSlip = HuDIsWheelSlipWarning = false;
+                WheelSlipWarningTimeS = 0;
+                slipDerivationMpSS = 0;
+                previousSlipSpeedMpS = 0;
+                slipDerivationPercentpS = 0;
+                previousSlipPercent = 0;
+                return;
+            }
+
             if (Axles.UsePolachAdhesion)
             {
                 forceToAccelerationFactor = WheelRadiusM * WheelRadiusM / totalInertiaKgm2;
@@ -1202,18 +1232,18 @@ public virtual void Update(float elapsedSeconds)
             // And thus there is a duplication of the braking effect in OR. To compensate for this, after the slip characteristics have been calculated, the output of the axle
             // module has the brake force "added" back in to give the appropriate motive force output for the locomotive. Braking force is handled separately.
             // Hence CompensatedAxleForce is the actual output force on the axle. Similarly friction is also handled separately so it is also discounted from the CompensatedForce.
-
+            
             // Make sure that compensated value never exceeds the "output" force, otherwise resulting value will be overcompensated
-            var CompensationVariation = BrakeRetardForceN + FrictionN;
+            var compensationVariation = BrakeRetardForceN + FrictionN;
 
-            if (CompensationVariation > Math.Abs(AxleForceN))
+            if (compensationVariation > Math.Abs(AxleForceN))
             {
-                CompensationVariation = Math.Abs(AxleForceN); ;
+                compensationVariation = Math.Abs(AxleForceN); ;
             }
 
             if (Math.Abs(TrainSpeedMpS) < 0.001f && AxleForceN == 0) CompensatedAxleForceN = 0;
-            else if (TrainSpeedMpS < 0) CompensatedAxleForceN = AxleForceN - CompensationVariation;
-            else CompensatedAxleForceN = AxleForceN + CompensationVariation;
+            else if (TrainSpeedMpS < 0) CompensatedAxleForceN = AxleForceN - compensationVariation;
+            else CompensatedAxleForceN = AxleForceN + compensationVariation;
 
             if (Math.Abs(SlipSpeedMpS) > WheelSlipThresholdMpS)
             {

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

@@ -2986,6 +2986,25 @@ internal void UpdatedTraveler(Traveller traveler, float elapsedTimeS, float dist
             CurrentCurveRadiusM = traveler.GetCurveRadius();
             UpdateVibrationAndTilting(traveler, elapsedTimeS, distanceM, speedMpS);
             UpdateSuperElevation(traveler, elapsedTimeS);
+
+            if (this is MSTSWagon wagon)
+            {        
+                bool isRackRailway = false;
+                var thisSection = traveler.GetCurrentSection();
+
+                if (thisSection != null && Simulator.TSectionDat.TrackShapes.ContainsKey(thisSection.ShapeIndex))
+                {
+                    TrackShape thisShape = Simulator.TSectionDat.TrackShapes[thisSection.ShapeIndex];
+                    isRackRailway |= thisShape.RackShape;
+                }
+                                
+                foreach (var axle in wagon.LocomotiveAxles)
+                {
+                    axle.IsRackRailway = isRackRailway;
+
+                    //  Trace.TraceInformation("IsRackRailway  {0} CarID {1}", axle.IsRackRailway, CarID);
+                }
+            }
         }
         #endregion
 

Source/RunActivity/Viewer3D/Popups/HUDWindow.cs

@@ -1177,7 +1177,8 @@ void TextPageForceInfo(TableData table)
                             table.CurrentRow = row0;
                             var axle = mstsLocomotive.LocomotiveAxles[i];
                             TableSetCell(table, table.CurrentRow++, table.CurrentValueColumn + 2 * i, "{0:F0}% ({1})", axle.SlipSpeedPercent, FormatStrings.FormatVeryLowSpeedDisplay((float)axle.WheelSlipThresholdMpS, mstsLocomotive.IsMetric));
-                            TableSetCell(table, table.CurrentRow++, table.CurrentValueColumn + 2 * i, "{0:F0}%", mstsLocomotive.AdhesionConditions * 100.0f);
+                            if (axle.IsRackRailway) TableSetCell(table, table.CurrentRow++, table.CurrentValueColumn + 2 * i, Viewer.Catalog.GetString("rack"));
+                            else TableSetCell(table, table.CurrentRow++, table.CurrentValueColumn + 2 * i, "{0:F0}%", mstsLocomotive.AdhesionConditions * 100.0f);
                             TableSetCell(table, table.CurrentRow++, table.CurrentValueColumn + 2 * i, "{0} ({1})", FormatStrings.FormatForce(axle.DriveForceN, mstsLocomotive.IsMetric), FormatStrings.FormatPower(axle.DriveForceN * mstsLocomotive.AbsTractionSpeedMpS, mstsLocomotive.IsMetric, false, false));
                             TableSetCell(table, table.CurrentRow++, table.CurrentValueColumn + 2 * i, "{0}", FormatStrings.FormatForce(axle.BrakeRetardForceN, mstsLocomotive.IsMetric));
                             TableSetCell(table, table.CurrentRow++, table.CurrentValueColumn + 2 * i, "{0:F0}", axle.NumOfSubstepsPS);