refactor: Consolidate over-water trough 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.
 // 
@@ -3118,7 +3118,7 @@ public virtual void UpdateWaterTroughRefill(float elapsedClockSeconds, float abs
                     RefillingFromTrough = false;
                     SignalEvent(Event.WaterScoopBroken);
                 }
-                else if (!IsOverTrough())
+                else if (!IsOverTrough)
                 {
                     if (!WaterScoopOverTroughFlag)
                     {
@@ -3163,7 +3163,7 @@ public virtual void UpdateWaterTroughRefill(float elapsedClockSeconds, float abs
                 }
 
             }
-            else if (HasWaterScoop && MSTSWagon.RefillProcess.OkToRefill == true && IsOverTrough())// water scoop has been raised, stop water filling
+            else if (HasWaterScoop && MSTSWagon.RefillProcess.OkToRefill == true && IsOverTrough)// water scoop has been raised, stop water filling
             {
                 MSTSWagon.RefillProcess.OkToRefill = false;
                 MSTSWagon.RefillProcess.ActivePickupObjectUID = 0;
@@ -3234,7 +3234,7 @@ public virtual void UpdateWaterTroughRefill(float elapsedClockSeconds, float abs
                 WaterScoopInputAmountL = 0;
                 WaterScoopVelocityMpS = 0;
 
-                if (!IsOverTrough()) // Only reset once train moves off the trough
+                if (!IsOverTrough) // Only reset once train moves off the trough
                 {
                     WaterScoopTotalWaterL = 0.0f; // Reset amount of water picked up by water sccop.
                 }

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

@@ -3525,7 +3525,7 @@ private void UpdateSpecialEffects(float elapsedClockSeconds)
                     }
 
                     // Water scoop spray effects control - always on when scoop over trough, regardless of whether above minimum speed or not
-                    if (ProcessWaterEffects && LocomotiveParameters.IsWaterScoopDown && IsOverTrough() && AbsSpeedMpS > 0.1)
+                    if (ProcessWaterEffects && LocomotiveParameters.IsWaterScoopDown && IsOverTrough && AbsSpeedMpS > 0.1)
                     {
                         float SpeedRatio = AbsSpeedMpS / MpS.FromMpH(100); // Ratio to reduce water disturbance with speed - an arbitary value of 100mph has been chosen as the reference
 

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

@@ -3094,6 +3094,7 @@ private void AddVibrations(float factor)
         #endregion
 
         public bool IsOverJunction { get; private set; }
+        public bool IsOverTrough { get; private set; }
 
         void UpdatePositionFlags()
         {
@@ -3107,6 +3108,7 @@ void UpdatePositionFlags()
             var frontOffsetM = rearOffsetM + CarLengthM;
 
             var isOverJunction = false;
+            var isOverTrough = 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`)
@@ -3121,6 +3123,14 @@ void UpdatePositionFlags()
                 if (checkedM <= frontOffsetM && rearOffsetM <= checkedM + section.Length)
                 {
                     if (section.CircuitType == TrackCircuitSection.TrackCircuitType.Junction || section.CircuitType == TrackCircuitSection.TrackCircuitType.Crossover) isOverJunction = true;
+                    if (section.TroughInfo != null)
+                    {
+                        foreach (var troughs in section.TroughInfo)
+                        {
+                            var trough = troughs[currentPin.Direction];
+                            if (checkedM + trough.TroughStart <= frontOffsetM && rearOffsetM <= checkedM + trough.TroughEnd) isOverTrough = true;
+                        }
+                    }
                 }
                 checkedM += section.Length;
 
@@ -3130,91 +3140,14 @@ void UpdatePositionFlags()
             }
 
             IsOverJunction = isOverJunction;
+            IsOverTrough = isOverTrough;
         }
 
         // TODO These three fields should be in the TrainCarViewer.
         public int TrackSoundType = 0;
         public WorldLocation TrackSoundLocation = WorldLocation.None;
         public float TrackSoundDistSquared = 0;
 
-
-        /// <summary>
-        /// Checks if traincar is over trough. Used to check if refill possible
-        /// </summary>
-        /// <returns> returns true if car is over trough</returns>
-
-        public bool IsOverTrough()
-        {
-            var isOverTrough = false;
-            // start at front of train
-            int thisSectionIndex = Train.PresentPosition[0].TCSectionIndex;
-            if (thisSectionIndex < 0) return isOverTrough;
-            float thisSectionOffset = Train.PresentPosition[0].TCOffset;
-            int thisSectionDirection = Train.PresentPosition[0].TCDirection;
-
-
-            float usedCarLength = CarLengthM;
-            float processedCarLength = 0;
-            bool validSections = true;
-
-            while (validSections)
-            {
-                TrackCircuitSection thisSection = Train.signalRef.TrackCircuitList[thisSectionIndex];
-                isOverTrough = false;
-
-                // car spans sections
-                if ((CarLengthM - processedCarLength) > thisSectionOffset)
-                {
-                    usedCarLength = thisSectionOffset - processedCarLength;
-                }
-
-                // section has troughs
-                if (thisSection.TroughInfo != null)
-                {
-                    foreach (TrackCircuitSection.troughInfoData[] thisTrough in thisSection.TroughInfo)
-                    {
-                        float troughStartOffset = thisTrough[thisSectionDirection].TroughStart;
-                        float troughEndOffset = thisTrough[thisSectionDirection].TroughEnd;
-
-                        if (troughStartOffset > 0 && troughStartOffset > thisSectionOffset)      // start of trough is in section beyond present position - cannot be over this trough nor any following
-                        {
-                            return isOverTrough;
-                        }
-
-                        if (troughEndOffset > 0 && troughEndOffset < (thisSectionOffset - usedCarLength)) // beyond end of trough, test next
-                        {
-                            continue;
-                        }
-
-                        if (troughStartOffset <= 0 || troughStartOffset < (thisSectionOffset - usedCarLength)) // start of trough is behind
-                        {
-                            isOverTrough = true;
-                            return isOverTrough;
-                        }
-                    }
-                }
-                // tested this section, any need to go beyond?
-
-                processedCarLength += usedCarLength;
-                {
-                    // go back one section
-                    int thisSectionRouteIndex = Train.ValidRoute[0].GetRouteIndexBackward(thisSectionIndex, Train.PresentPosition[0].RouteListIndex);
-                    if (thisSectionRouteIndex >= 0)
-                    {
-                        thisSectionIndex = thisSectionRouteIndex;
-                        thisSection = Train.signalRef.TrackCircuitList[thisSectionIndex];
-                        thisSectionOffset = thisSection.Length;  // always at end of next section
-                        thisSectionDirection = Train.ValidRoute[0][thisSectionRouteIndex].Direction;
-                    }
-                    else // ran out of train
-                    {
-                        validSections = false;
-                    }
-                }
-            }
-            return isOverTrough;
-        }
-
         public static WorldLocation TileLocation(UiD uid)
         {
             return new WorldLocation(uid.TileX, uid.TileZ, uid.X, uid.Y, uid.Z);

Source/RunActivity/Viewer3D/Popups/TrainDrivingWindow.cs

@@ -1187,7 +1187,7 @@ void AddSeparator() => AddLabel(new ListLabel
                 }
                 else if (locomotive.IsWaterScoopDown && !locomotive.ScoopIsBroken)
                 {
-                    waterScoopIndicator = Viewer.Catalog.GetString("Down") + (locomotive.IsOverTrough() ? ColorCode[Color.Cyan] : ColorCode[Color.Orange]);
+                    waterScoopIndicator = Viewer.Catalog.GetString("Down") + (locomotive.IsOverTrough ? ColorCode[Color.Cyan] : ColorCode[Color.Orange]);
                     waterScoopKey = Symbols.ArrowToRight + ColorCode[Color.Yellow];
                 }
                 else

Source/RunActivity/Viewer3D/WebServices/TrainDrivingDisplay.cs

@@ -729,7 +729,7 @@ void AddSeparator() => AddLabel(new ListLabel
                 }
                 else if (locomotive.WaterScoopDown && !locomotive.ScoopIsBroken)
                 {
-                    waterScoopIndicator = Viewer.Catalog.GetString("Down") + (locomotive.IsOverTrough() ? ColorCode[Color.Cyan] : ColorCode[Color.Orange]);
+                    waterScoopIndicator = Viewer.Catalog.GetString("Down") + (locomotive.IsOverTrough ? ColorCode[Color.Cyan] : ColorCode[Color.Orange]);
                     waterScoopKey = Symbols.ArrowToRight + ColorCode[Color.Yellow];
                 }
                 else