refactor: Consolidate over-junction check to new scanner

Author: twpol

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

@@ -1,4 +1,4 @@
-// COPYRIGHT 2009, 2010, 2011, 2012, 2013 by the Open Rails project.
+// COPYRIGHT 2009, 2010, 2011, 2012, 2013 by the Open Rails project.
 // 
 // This file is part of Open Rails.
 // 
@@ -3108,7 +3108,7 @@ public virtual void UpdateWaterTroughRefill(float elapsedClockSeconds, float abs
                     Simulator.Confirmer.Message(ConfirmLevel.Error, Simulator.Catalog.GetString("Scoop is broken, can't refill"));
                     RefillingFromTrough = false;
                 }
-                else if (IsOverJunction())
+                else if (IsOverJunction)
                 {
                     if (!ScoopIsBroken) // Only display message first time scoop is broken
                     {

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

@@ -1,4 +1,4 @@
-// COPYRIGHT 2009 - 2022 by the Open Rails project.
+// COPYRIGHT 2009 - 2022 by the Open Rails project.
 // 
 // This file is part of Open Rails.
 // 
@@ -3093,6 +3093,8 @@ private void AddVibrations(float factor)
         }
         #endregion
 
+        public bool IsOverJunction { get; private set; }
+
         void UpdatePositionFlags()
         {
             // Position flags can only change when we're moving!
@@ -3104,6 +3106,8 @@ void UpdatePositionFlags()
                 rearOffsetM += Train.Cars[i - 1].CouplerSlackM + Train.Cars[i - 1].GetCouplerZeroLengthM() + Train.Cars[i].CarLengthM;
             var frontOffsetM = rearOffsetM + CarLengthM;
 
+            var isOverJunction = false;
+
             // Scan through the track sections forwards from the REAR of the train (`Train.PresentPosition[1]`),
             // stopping as soon as we've passed this car (`checkedM`) or run out of track (`currentPin.Link`)
             var checkedM = 0f;
@@ -3116,13 +3120,16 @@ void UpdatePositionFlags()
                 // Does this car overlap this track section?
                 if (checkedM <= frontOffsetM && rearOffsetM <= checkedM + section.Length)
                 {
+                    if (section.CircuitType == TrackCircuitSection.TrackCircuitType.Junction || section.CircuitType == TrackCircuitSection.TrackCircuitType.Crossover) isOverJunction = true;
                 }
                 checkedM += section.Length;
 
                 var nextPin = section.GetNextActiveLink(currentPin.Direction, lastPin.Link);
                 lastPin = currentPin;
                 currentPin = nextPin;
             }
+
+            IsOverJunction = isOverJunction;
         }
 
         // TODO These three fields should be in the TrainCarViewer.
@@ -3208,58 +3215,6 @@ public bool IsOverTrough()
             return isOverTrough;
         }
 
-        /// <summary>
-        /// Checks if traincar is over junction or crossover. Used to check if water scoop breaks
-        /// </summary>
-        /// <returns> returns true if car is over junction</returns>
-
-        public bool IsOverJunction()
-        {
-
-            // To Do - This identifies the start of the train, but needs to be further refined to work for each carriage.
-            var isOverJunction = false;
-            // start at front of train
-            int thisSectionIndex = Train.PresentPosition[0].TCSectionIndex;
-            float thisSectionOffset = Train.PresentPosition[0].TCOffset;
-            int thisSectionDirection = Train.PresentPosition[0].TCDirection;
-
-
-            float usedCarLength = CarLengthM;
-
-            if (Train.PresentPosition[0].TCSectionIndex != Train.PresentPosition[1].TCSectionIndex)
-            {
-                try
-                {
-                    var copyOccupiedTrack = Train.OccupiedTrack.ToArray();
-                    foreach (var thisSection in copyOccupiedTrack)
-                    {
-
-                        //                    Trace.TraceInformation(" Track Section - Index {0} Ciruit Type {1}", thisSectionIndex, thisSection.CircuitType);
-
-                        if (thisSection.CircuitType == TrackCircuitSection.TrackCircuitType.Junction || thisSection.CircuitType == TrackCircuitSection.TrackCircuitType.Crossover)
-                        {
-
-                            // train is on a switch; let's see if car is on a switch too
-                            WorldLocation switchLocation = TileLocation(Simulator.TDB.TrackDB.TrackNodes[thisSection.OriginalIndex].UiD);
-                            var distanceFromSwitch = WorldLocation.GetDistanceSquared(WorldPosition.WorldLocation, switchLocation);
-                            if (distanceFromSwitch < CarLengthM * CarLengthM + Math.Min(SpeedMpS * 3, 150))
-                            {
-                                isOverJunction = true;
-                                return isOverJunction;
-                            }
-                        }
-                    }
-                }
-                catch
-                {
-
-                }
-            }
-
-            return isOverJunction;
-        }
-
-
         public static WorldLocation TileLocation(UiD uid)
         {
             return new WorldLocation(uid.TileX, uid.TileZ, uid.X, uid.Y, uid.Z);

Source/RunActivity/Viewer3D/Sound.cs

@@ -395,32 +395,8 @@ public bool UpdateCarOnSwitchAndCurve()
 
                     var CarBehind = Car.Train.Cars[CarNo + CarIncr];
                     var carPreviouslyOnSwitch = CarOnSwitch;
-                    CarOnSwitch = false;
-                    if (Car.Train.PresentPosition[0].TCSectionIndex != Car.Train.PresentPosition[1].TCSectionIndex)
-                    {
-                        try
-                        {
-                            var copyOccupiedTrack = Car.Train.OccupiedTrack.ToArray();
-                            foreach (var thisSection in copyOccupiedTrack)
-                            {
-                                if (thisSection.CircuitType == TrackCircuitSection.TrackCircuitType.Junction || thisSection.CircuitType == TrackCircuitSection.TrackCircuitType.Crossover)
-                                {
-                                    // train is on a switch; let's see if car is on a switch too
-                                    WorldLocation switchLocation = UidLocation(Viewer.Simulator.TDB.TrackDB.TrackNodes[thisSection.OriginalIndex].UiD);
-                                    var distanceFromSwitch = WorldLocation.GetDistanceSquared(Car.WorldPosition.WorldLocation, switchLocation);
-                                    if (distanceFromSwitch < Car.CarLengthM * Car.CarLengthM + Math.Min(Car.SpeedMpS * 3, 150))
-                                    {
-                                        CarOnSwitch = true;
-                                        break;
-                                    }
-                                }
-                            }
-                        }
-                        catch
-                        {
+                    CarOnSwitch = Car.IsOverJunction;
 
-                        }
-                    }
                     // here check for curve
                     var carPreviouslyOnCurve = CarOnCurve;
                     CarOnCurve = false;