Improve reliability of selecting correct track profile for each track shape

Author: SteelFill

Source/RunActivity/Viewer3D/DynamicTrack.cs

@@ -29,6 +29,7 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.Linq;
 using System.Xml;
 using System.Xml.Schema;
 
@@ -216,24 +217,75 @@ public void Mark()
         }
 
         /// <summary>
-        /// Returns the index of the track profile that best suits the given TrVectorSection
-        /// The result is cached in the section object for future use
+        /// Returns the index of the track profile that best suits the given Viewer and TrVectorSection object,
+        /// with an optional shape file name to use as reference.
+        /// The result is cached in the vector section object for future use
         /// </summary>
         /// <returns>Index of viewer.TRPs</returns>
-        public static int GetBestTrackProfile(Viewer viewer, TrVectorSection trSection)
+        public static int GetBestTrackProfile(Viewer viewer, TrVectorSection trSection, string shapeName = "")
         {
-            string shapeName = "";
-            if (viewer.Simulator.TSectionDat.TrackShapes.ContainsKey(trSection.ShapeIndex))
+            int trpIndex;
+            if (shapeName == "" && viewer.Simulator.TSectionDat.TrackShapes.ContainsKey(trSection.ShapeIndex))
                 shapeName = viewer.Simulator.TSectionDat.TrackShapes.Get(trSection.ShapeIndex).FileName;
 
-            viewer.TrackProfileIndicies.TryGetValue(shapeName, out int trpIndex);
+            if (viewer.TrackProfileIndicies.ContainsKey(shapeName))
+                viewer.TrackProfileIndicies.TryGetValue(shapeName, out trpIndex);
+            else if (shapeName != "") // Haven't checked this track shape yet
+            {
+                // Need to load the shape file if not already loaded
+                var trackShape = viewer.ShapeManager.Get(viewer.Simulator.BasePath + @"\Global\Shapes\" + shapeName);
+                trpIndex = GetBestTrackProfile(viewer, trackShape);
+                viewer.TrackProfileIndicies.Add(shapeName, trpIndex);
+            }
+            else // Not enough info-use default track profile
+                trpIndex = 0;
 
             trSection.TRPIndex = trpIndex;
             return trpIndex;
         }
         // Note: Dynamic track objects will ALWAYS use TRPIndex = 0
         // This is because dynamic tracks don't have shapes, and as such lack the information needed
         // to select a specific track profile.
+
+        /// <summary>
+        /// Determines the index of the track profile that would be the most suitable replacement
+        /// for the given shared shape object.
+        /// </summary>
+        public static int GetBestTrackProfile(Viewer viewer, SharedShape shape)
+        {
+            float score = float.NegativeInfinity;
+            int bestIndex = -1;
+            for (int i = 0; i < viewer.TRPs.Count; i++)
+            {
+                float bestScore = score;
+                score = 0;
+                // Default behavior: Attempt to match track shape to track profile using texture names alone
+                foreach (string image in viewer.TRPs[i].TrackProfile.Images)
+                {
+                    if (shape.ImageNames != null && shape.ImageNames.Contains(image, StringComparer.InvariantCultureIgnoreCase))
+                        score++;
+                    else // Slight bias against track profiles with extra textures defined
+                        score -= 0.05f;
+                }
+                if (score > bestScore && shape.ImageNames != null) // Only continue checking if current profile might be the best one
+                {
+                    foreach (string image in shape.ImageNames)
+                    {
+                        // Strong bias against track profiles that are missing textures
+                        if (!viewer.TRPs[i].TrackProfile.Images.Contains(image, StringComparer.InvariantCultureIgnoreCase))
+                            score -= 0.25f;
+                    }
+                }
+                if (score > bestScore)
+                    bestIndex = i;
+                else
+                    score = bestScore;
+            }
+
+            if (bestIndex < 0)
+                bestIndex = 0;
+            return bestIndex;
+        }
     }
 
     // A track profile consists of a number of groups used for LOD considerations.  There are LODs,

Source/RunActivity/Viewer3D/Scenery.cs

@@ -300,6 +300,14 @@ public WorldFile(Viewer viewer, int tileX, int tileZ, bool visible)
                     }
             }
 
+            // Generate track profiles if none have been set up yet
+            if (viewer.TRPs == null)
+            {
+                Trace.Write(" TRP");
+                // Creates profile and loads materials into SceneryMaterials
+                TRPFile.CreateTrackProfile(viewer, viewer.Simulator.RoutePath, out viewer.TRPs);
+            }
+
             // create all the individual scenery objects specified in the WFile
             foreach (var worldObject in WFile.Tr_Worldfile)
             {
@@ -369,25 +377,15 @@ public WorldFile(Viewer viewer, int tileX, int tileZ, bool visible)
                         {
                             if (viewer.Simulator.UseSuperElevation > 0)
                                 SuperElevationManager.DecomposeStaticSuperElevation(viewer, dTrackList, trackObj, worldMatrix, TileX, TileZ, shapeFilePath);
-                            var newScenery = new SwitchTrackShape(viewer, shapeFilePath, worldMatrix, trJunctionNode);
-                            sceneryObjects.Add(newScenery);
-
-                            string newShapeName = Path.GetFileName(newScenery.SharedShape.FilePath);
-                            if (!viewer.TrackProfileIndicies.ContainsKey(newShapeName))
-                                viewer.TrackProfileIndicies.Add(newShapeName, GetBestTrackProfile(viewer, newScenery.SharedShape));
+                            sceneryObjects.Add(new SwitchTrackShape(viewer, shapeFilePath, worldMatrix, trJunctionNode));
                         }
                         else
                         {
                             //if want to use super elevation, we will generate tracks using dynamic tracks
                             if (viewer.Simulator.UseSuperElevation > 0
                                 && SuperElevationManager.DecomposeStaticSuperElevation(viewer, dTrackList, trackObj, worldMatrix, TileX, TileZ, shapeFilePath))
                             {
-                                // Need to load the static shape file to determine which track profile to use
-                                var superelevatedShape = viewer.ShapeManager.Get(shapeFilePath);
-
-                                string newShapeName = Path.GetFileName(superelevatedShape.FilePath);
-                                if (!viewer.TrackProfileIndicies.ContainsKey(newShapeName))
-                                    viewer.TrackProfileIndicies.Add(newShapeName, GetBestTrackProfile(viewer, superelevatedShape));
+                                // No need to add shapes for this segment of track
                             }
                             //otherwise, use shapes
                             else if (!containsMovingTable) sceneryObjects.Add(new StaticTrackShape(viewer, shapeFilePath, worldMatrix));
@@ -664,52 +662,6 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
                 forest.PrepareFrame(frame, elapsedTime);
         }
 
-        /// <summary>
-        /// Determines the index of the track profile that would be the most suitable replacement
-        /// for the given shared shape object.
-        /// </summary>
-        public static int GetBestTrackProfile(Viewer viewer, SharedShape shape)
-        {
-            if (viewer.TRPs == null)
-            {
-                // First to need a track profile creates it
-                Trace.Write(" TRP");
-                // Creates profile and loads materials into SceneryMaterials
-                TRPFile.CreateTrackProfile(viewer, viewer.Simulator.RoutePath, out viewer.TRPs);
-            }
-
-            float score = float.NegativeInfinity;
-            int bestIndex = -1;
-            for (int i = 0; i < viewer.TRPs.Count; i++)
-            {
-                float prevScore = score;
-                score = 0;
-                // Default behavior: Attempt to match track shape to track profile using texture names alone
-                foreach (string image in viewer.TRPs[i].TrackProfile.Images)
-                {
-                    if (shape.ImageNames.Contains(image, StringComparer.InvariantCultureIgnoreCase))
-                        score++;
-                    else // Slight bias against track profiles with extra textures defined
-                        score -= 0.05f;
-                }
-                foreach (string image in shape.ImageNames)
-                {
-                    // Strong bias against track profiles that are missing textures
-                    if (!viewer.TRPs[i].TrackProfile.Images.Contains(image, StringComparer.InvariantCultureIgnoreCase))
-                        score -= 0.25f;
-                }
-                if (score > prevScore)
-                    bestIndex = i;
-                else
-                    score = prevScore;
-            }
-
-            if (bestIndex < 0)
-                return 0;
-            else
-                return bestIndex;
-        }
-
         /// <summary>
         /// MSTS WFiles represent some location with a position, quaternion and tile coordinates
         /// This converts it to the ORTS WorldPosition representation

Source/RunActivity/Viewer3D/SuperElevation.cs

@@ -24,7 +24,7 @@
 using ORTS.Common;
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
+using System.IO;
 
 namespace Orts.Viewer3D
 {
@@ -85,6 +85,11 @@ public static bool DecomposeStaticSuperElevation(Viewer viewer, List<DynamicTrac
                     }
                     sectionsinShape.Add(tmp);
 
+                    // Determine the track profile to use for this section
+                    // It's possible that the tsection ID used by the track section points to the wrong shape
+                    // Use the static shape name instead to get expected results
+                    DynamicTrackViewer.GetBestTrackProfile(viewer, tmp, Path.GetFileName(shapeFilePath));
+
                     drawn++;
                 }
             }