Light handling changes

Author: pzgulyas

Source/ORTS.Common/ConsistGenerator.cs

@@ -39,17 +39,42 @@ public class ConsistGenerator
         /// </summary>
         public static bool GltfVisualTestRun;
 
-        const string ConsistTemplateStart = @"Train (
-            TrainCfg ( ""trainname""
-                Name ( ""trainname"" )
-                MaxVelocity ( 50 1 )
+        const string ConsistTemplateStart =
+            @"Train (
+                TrainCfg ( ""trainname""
+                    Name ( ""trainname"" )
+                    MaxVelocity ( 50 1 )
             ";
         const string ConsistTemplateRecord = @"Engine ( UID ( xx ) EngineData ( ""engfile"" ""trainsetdir"" ) )" + "\r\n";
         const string ConsistTemplateEnd = ")\r\n)";
-        const string EngineTemplate = @"Wagon ( ""enginname""
+        const string EngineTemplate =
+            @"Wagon ( ""enginname""
                 Type ( Engine )
                 WagonShape ( ""shapefilename"" )
                 Size (100m 7m 100m )
+                Lights ( 1
+                    Light (
+                        Type ( 1 )
+                        ShapeHierarchy ( Headlight )
+                        Conditions ( 
+                            Headlight ( 3 )
+                            Unit ( 2 )
+                        )
+                        Cycle ( 0 )
+                        FadeIn ( 1 )
+                        FadeOut ( 1 )
+                        States ( 1
+                            State (
+                                Duration ( 0.0 )
+                                LightColour ( ffffffff )
+                                Position ( 0 0 0 )
+                                Transition ( 0 )
+                                Radius ( 400 )
+                                Angle ( 15 )
+                            )
+                        )
+                    )
+                )
             )
             Engine ( ""enginname""
                 Wagon ( ""enginname"" )

Source/RunActivity/Viewer3D/GltfShape.cs

@@ -1071,6 +1071,7 @@ public class GltfSubObject : SubObject
 
             public GltfSubObject(KHR_lights_punctual light, int hierarchyIndex, int[] hierarchy, Gltf gltfFile, GltfShape shape, GltfDistanceLevel distanceLevel)
             {
+                HierarchyIndex = hierarchyIndex;
                 ShapePrimitives = new[] { new GltfPrimitive(light, gltfFile, distanceLevel, hierarchyIndex, hierarchy) };
             }
 
@@ -1434,21 +1435,22 @@ public class GltfPrimitive : ShapePrimitive
 
 
             public GltfPrimitive(KHR_lights_punctual light, Gltf gltfFile, GltfDistanceLevel distanceLevel, int hierarchyIndex, int[] hierarchy)
-                : this(new EmptyMaterial(distanceLevel.Viewer), Enumerable.Empty<VertexBufferBinding>().ToList(), gltfFile, distanceLevel, new GltfIndexBufferSet(), null, hierarchyIndex, hierarchy, Vector4.Zero, Vector4.Zero, 0, new int[0])
+                : this(new EmptyMaterial(distanceLevel.Viewer), Enumerable.Empty<VertexBufferBinding>().ToList(), gltfFile, distanceLevel, new GltfIndexBufferSet(), null, hierarchyIndex, hierarchy, Vector4.Zero, Vector4.Zero, 0, Array.Empty<int>())
             {
-                Light = new ShapeLight
+                object extension = null;
+                Light = new StaticLight
                 {
                     Name = light.name,
                     Type = light.type,
                     Color = light.color != null && light.color.Length > 2 ? new Vector3(light.color[0], light.color[1], light.color[2]) : Vector3.Zero,
                     Intensity = light.intensity,
-                    Range = light.range,
+                    Range = light.range == 0 ? 2000 : light.range,
+                    InnerConeCos = (float)Math.Cos(light.spot?.innerConeAngle ?? 0),
+                    OuterConeCos = (float)Math.Cos(light.spot?.outerConeAngle ?? MathHelper.Pi),
+                    ManagedName = (light.Extras?.TryGetValue("OPENRAILS_light_name", out extension) ?? false) && extension is string a ? a : null,
                 };
-                if (Light.Type == LightMode.Spot && light.spot != null)
-                {
-                    Light.InnerConeCos = (float)Math.Cos(light.spot.innerConeAngle);
-                    Light.OuterConeCos = (float)Math.Cos(light.spot.outerConeAngle);
-                }
+                if (Light.ManagedName != null)
+                    distanceLevel.MatrixNames.Add(Light.ManagedName);
             }
 
             public GltfPrimitive(Material material, List<VertexBufferBinding> vertexAttributes, Gltf gltfFile, GltfDistanceLevel distanceLevel, GltfIndexBufferSet indexBufferSet, Skin skin, int hierarchyIndex, int[] hierarchy, Vector4 texCoords1, Vector4 texCoords2, int texturePacking, int[] morphConfig)
@@ -1636,6 +1638,8 @@ public class KHR_lights_punctual
             public float range { get; set; }
 
             public KHR_lights_punctual_spot spot { get; set; }
+
+            public Dictionary<string, object> Extras { get; set; }
         }
 
         public class KHR_lights_punctual_spot

Source/RunActivity/Viewer3D/Lights.cs

@@ -85,9 +85,6 @@ public class LightViewer
         public float LightConeMinDotProduct;
         public Vector4 LightConeColor;
 
-        bool PreviousIsLightConeActive; // previous IsLightConeActive
-        ElapsedTime FadeTimer = ElapsedTime.Zero;
-
         public LightViewer(Viewer viewer, TrainCar car, TrainCarViewer carViewer)
         {
             Viewer = viewer;
@@ -130,16 +127,19 @@ public LightViewer(Viewer viewer, TrainCar car, TrainCarViewer carViewer)
                     {
                         if (light.ShapeHierarchy != null)
                         {
-                            if ((CarViewer as MSTSWagonViewer).TrainCarShape.SharedShape.MatrixNames.Contains(light.ShapeHierarchy))
-                            {
-                                light.ShapeIndex = (CarViewer as MSTSWagonViewer).TrainCarShape.SharedShape.MatrixNames.IndexOf(light.ShapeHierarchy);
-                            }
-                            else
+                            if (TrySetLightManaged((CarViewer as MSTSWagonViewer).TrainCarShape.SharedShape, light.ShapeHierarchy) is var index && index < 0)
+                                index = (CarViewer as MSTSWagonViewer).TrainCarShape.SharedShape.MatrixNames.IndexOf(light.ShapeHierarchy);
+
+                            if (index < 0)
                             {
                                 Trace.TraceWarning("Light in car {0} has invalid shape index defined, shape name {1} does not exist",
                                     (Car as MSTSWagon).WagFilePath, light.ShapeHierarchy);
                                 light.ShapeIndex = 0;
                             }
+                            else
+                            {
+                                light.ShapeIndex = index;
+                            }
                         }
                         else
                             light.ShapeIndex = 0;
@@ -251,9 +251,6 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
                             frame.AddPrimitive(LightConeMaterial, lightPrimitive, RenderPrimitiveGroup.Lights, ref xnaDTileTranslation);
 #endif
 
-            FadeTimer += elapsedTime;
-
-            // TODO: Theoretically the headlight handling could be moved to the TrainCar level. Now we can have multiple of these.
             if (HasLightCone && ActiveLightCone != null)
             {
                 int coneIndex = ActiveLightCone.Light.ShapeIndex;
@@ -266,23 +263,18 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
                 LightConeMinDotProduct = (float)Math.Cos(MathHelper.Lerp(ActiveLightCone.Angle1, ActiveLightCone.Angle2, ActiveLightCone.Fade.Y));
                 LightConeColor = Vector4.Lerp(ActiveLightCone.Color1, ActiveLightCone.Color2, ActiveLightCone.Fade.Y);
 
-                if (PreviousIsLightConeActive != IsLightConeActive)
-                {
-                    PreviousIsLightConeActive = IsLightConeActive;
-                    FadeTimer = ElapsedTime.Zero;
-                }
-
-                // The original shaders followed the phylisophy of wanting 50% brightness at half the range. (LightConeDistance is only the half)
-                // For the new calculation method the full range is needed.
-                var range = LightConeDistance * 2;
-                var color = new Vector3(LightConeColor.X, LightConeColor.Y, LightConeColor.Z);
-
-                var fadingIntensity = FadeTimer.ClockSeconds / (Math.Max(LightConeFadeIn, LightConeFadeOut) + float.Epsilon);
-                if (!IsLightConeActive)
-                    fadingIntensity = 1 - fadingIntensity;
-
-                if (fadingIntensity > 0)
-                    frame.AddLight(LightMode.Spot, LightConePosition, LightConeDirection, color, RenderFrame.HeadLightIntensity, range, 1, LightConeMinDotProduct, fadingIntensity, false);
+                if (ActiveLightCone.Fade.X > 0)
+                    frame.AddLight(LightMode.Spot,
+                        LightConePosition,
+                        LightConeDirection,
+                        new Vector3(LightConeColor.X, LightConeColor.Y, LightConeColor.Z),
+                        RenderFrame.HeadLightIntensity,
+                        // The original shaders followed the phylisophy of wanting 50% brightness at half the range. (LightConeDistance is only the half)
+                        LightConeDistance * 2, // For the new calculation method the full range is needed.
+                        1,
+                        LightConeMinDotProduct,
+                        ActiveLightCone.Fade.X,
+                        false);
             }
         }
 
@@ -446,6 +438,20 @@ bool UpdateState()
             }
             return false;
         }
+
+        static int TrySetLightManaged(SharedShape sharedShape, string lightName)
+        {
+            if (sharedShape.LodControls
+                .SelectMany(l => l.DistanceLevels)
+                .SelectMany(d => d.SubObjects)
+                .SelectMany(s => s.ShapePrimitives)
+                .FirstOrDefault(p => lightName.Equals(p.Light?.ManagedName, StringComparison.OrdinalIgnoreCase)) is var primitive && primitive != null)
+            {
+                primitive.Light.IsManaged = true;
+                return primitive.HierarchyIndex;
+            }
+            return -1;
+        }
     }
 
     public abstract class LightPrimitive : RenderPrimitive
@@ -705,7 +711,7 @@ public void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
             else if (FadeOut)
             {
                 FadeTime += elapsedTime.ClockSeconds;
-                Fade.X = 1 - FadeTime / Light.FadeIn;
+                Fade.X = 1 - FadeTime / Light.FadeOut;
                 if (Fade.X < 0)
                 {
                     FadeOut = false;
@@ -785,6 +791,20 @@ public override void Draw(GraphicsDevice graphicsDevice)
         }
     }
 
+    public class StaticLight
+    {
+        public string Name;
+        public LightMode Type;
+        public Vector3 Color;
+        public float Intensity;
+        public float Range;
+        public float InnerConeCos;
+        public float OuterConeCos;
+
+        public string ManagedName;
+        public bool IsManaged;
+    }
+    
     struct LightGlowVertex
     {
         public Vector3 PositionO;

Source/RunActivity/Viewer3D/RenderFrame.cs

@@ -144,6 +144,8 @@ static internal VertexBuffer GetDummyVertexBuffer(GraphicsDevice graphicsDevice)
             }
             return DummyVertexBuffer;
         }
+
+        public StaticLight Light { get; protected set; }
     }
 
     [DebuggerDisplay("{Material} {RenderPrimitive} {Flags}")]
@@ -391,7 +393,7 @@ public class RenderFrame
         const float SunIntensity = 1;
         const float MoonIntensity = SunIntensity / 380000;
         public const float HeadLightIntensity = 25000; // See some sample values: https://docs.unity3d.com/Packages/com.unity.cloud.gltfast@5.2/manual/LightUnits.html
-        float LightClampTo = 1;
+        float LightDayNightClampTo = 1;
         float LightDayNightMultiplier = 1;
 
         // Local shadow map data.
@@ -566,17 +568,17 @@ public void PrepareFrame(Viewer viewer)
 
             if (SolarDirection.Y <= -0.05)
             {
-                LightClampTo = 1; // at nighttime max light
+                LightDayNightClampTo = 1; // at nighttime max light
                 LightDayNightMultiplier = 1;
             }
             else if (SolarDirection.Y >= 0.15)
             {
-                LightClampTo = 0.5f; // at daytime min light
+                LightDayNightClampTo = 0.5f; // at daytime min light
                 LightDayNightMultiplier = 0.1f;
             }
             else
             {
-                LightClampTo = 1 - 2.5f * (SolarDirection.Y + 0.05f); // in the meantime interpolate
+                LightDayNightClampTo = 1 - 2.5f * (SolarDirection.Y + 0.05f); // in the meantime interpolate
                 LightDayNightMultiplier = 1 - 4.5f * (SolarDirection.Y + 0.05f);
             }
         }
@@ -663,7 +665,12 @@ public void AddAutoPrimitive(Vector3 mstsLocation, float objectRadius, float obj
             if (float.IsPositiveInfinity(objectViewingDistance) || (Camera != null && Camera.InRange(mstsLocation, objectRadius, objectViewingDistance)))
             {
                 if (Camera != null && Camera.InFov(mstsLocation, objectRadius))
+                {
                     AddPrimitive(material, primitive, group, ref xnaMatrix, flags, itemData);
+
+                    if (primitive?.Light != null && !primitive.Light.IsManaged && primitive.Light.Range > 0 && Camera.InRange(mstsLocation, objectRadius, primitive.Light.Range))
+                        AddLight(primitive.Light, ref xnaMatrix);
+                }
             }
 
             if (Game.Settings.DynamicShadows && (RenderProcess.ShadowMapCount > 0) && ((flags & ShapeFlags.ShadowCaster) != 0))
@@ -1049,17 +1056,35 @@ void DrawSequencesDistantMountains(GraphicsDevice graphicsDevice, bool logging)
             }
         }
 
-        public void AddLight(ShapeLight light, ref Matrix worldMatrix, float lodBias, float fadingIntensity)
+        /// <summary>
+        /// Add unmanaged static lights
+        /// </summary>
+        public void AddLight(StaticLight light, ref Matrix worldMatrix)
         {
             // Do not allow directional light injection. That is reserved to the sun and the moon.
-            if (light != null && light.Type != LightMode.Directional)
-                AddLight(light.Type, worldMatrix.Translation, Vector3.TransformNormal(-Vector3.UnitZ, worldMatrix), light.Color, light.Intensity, light.Range, light.InnerConeCos, light.OuterConeCos, fadingIntensity, false);
+            if (light != null && !light.IsManaged && light.Type != LightMode.Directional)
+                AddLight(light.Type, worldMatrix.Translation, Vector3.TransformNormal(-Vector3.UnitZ, worldMatrix), light.Color, light.Intensity, light.Range, light.InnerConeCos, light.OuterConeCos, 1, false);
         }
+
+        /// <summary>
+        /// Used for the Sun / Moon only, intensity is in lm/m2
+        /// </summary>
+        void AddLight(Vector3 direction, Vector3 color, float intensity, float fade) => AddLight(LightMode.Directional, Vector3.Zero, direction, color, intensity, -1, 0, 0, fade, true);
+
         /// <summary>
-        /// Used for Sun / Moon only
+        /// Add an active light to the actually compiled frame.
         /// </summary>
-        public void AddLight(Vector3 direction, Vector3 color, float intensity, float fadingIntensity) => AddLight(LightMode.Directional, Vector3.Zero, direction, color, intensity, -1, 0, 0, fadingIntensity, true);
-        public void AddLight(LightMode type, Vector3 position, Vector3 direction, Vector3 color, float intensity, float range, float innerConeCos, float outerConeCos, float fadingIntensity, bool ignoreDayNight)
+        /// <param name="type">Can be Point or Spot only. Use the Directional type only for the Sun and the Moon.</param>
+        /// <param name="position">The worldMatrix.Translation</param>
+        /// <param name="direction">The light direction</param>
+        /// <param name="color">The light color</param>
+        /// <param name="intensity">Luminous intensity in candela (lm/sr)</param>
+        /// <param name="range">Cutoff distance</param>
+        /// <param name="innerConeCos"></param>
+        /// <param name="outerConeCos"></param>
+        /// <param name="fade">Fading, 0 no light, 1 full light</param>
+        /// <param name="ignoreDayNight">At daytime the intensity is automatically reduced to match the sunlight. Disable this by this parameter.</param>
+        public void AddLight(LightMode type, Vector3 position, Vector3 direction, Vector3 color, float intensity, float range, float innerConeCos, float outerConeCos, float fade, bool ignoreDayNight)
         {
             if (NumLights >= RenderProcess.MAX_LIGHTS)
                 return;
@@ -1068,8 +1093,9 @@ public void AddLight(LightMode type, Vector3 position, Vector3 direction, Vector
             LightPositions[NumLights] = position;
             LightDirections[NumLights] = direction;
             LightColors[NumLights] = color;
-            LightIntensities[NumLights] = intensity
-                * (ignoreDayNight ? MathHelper.Clamp(fadingIntensity, 0, 1) : MathHelper.Clamp(fadingIntensity * LightDayNightMultiplier * LightClampTo, 0, LightClampTo));
+            LightIntensities[NumLights] = intensity * (ignoreDayNight
+                ? MathHelper.Clamp(fade, 0, 1)
+                : MathHelper.Clamp(fade * LightDayNightMultiplier * LightDayNightClampTo, 0, LightDayNightClampTo));
             LightRanges[NumLights] = range * (ignoreDayNight ? 1 : LightDayNightMultiplier);
             LightInnerConeCos[NumLights] = innerConeCos;
             LightOuterConeCos[NumLights] = outerConeCos;

Source/RunActivity/Viewer3D/Shapes.cs

@@ -79,7 +79,6 @@ public SharedShape Get(string path)
                 }
                 catch (Exception error)
                 {
-                    if (Debugger.IsAttached) Debugger.Break();
                     Trace.WriteLine(new FileLoadException(path, error));
                     Shapes.Add(path, EmptyShape);
                 }
@@ -1783,7 +1782,6 @@ public class ShapePrimitive : RenderPrimitive, IDisposable
         public Material Material { get; protected set; }
         public int[] Hierarchy { get; protected set; } // the hierarchy from the sub_object
         public int HierarchyIndex { get; protected set; } // index into the hiearchy array which provides pose for this primitive
-        public ShapeLight Light { get; protected set; }
 
         protected internal VertexBuffer VertexBuffer;
         protected internal IndexBuffer IndexBuffer;
@@ -2660,7 +2658,6 @@ public void PrepareFrame(RenderFrame frame, WorldPosition location, Matrix[] ani
 
                         var interior = (flags & ShapeFlags.Interior) != 0;
                         frame.AddAutoPrimitive(mstsLocation, distanceDetail.ViewSphereRadius, distanceDetail.ViewingDistance * lodBias, shapePrimitive.Material, shapePrimitive, interior ? RenderPrimitiveGroup.Interior : RenderPrimitiveGroup.World, ref xnaMatrix, flags, bones);
-                        frame.AddLight(shapePrimitive.Light, ref xnaMatrix, lodBias, 1);
                     }
                 }
             }
@@ -2744,19 +2741,6 @@ public void Dispose()
         }
     }
 
-    public class ShapeLight
-    {
-        public string Name;
-        public LightMode Type;
-        public Vector3 Position;
-        public Vector3 Direction;
-        public Vector3 Color;
-        public float Intensity;
-        public float Range;
-        public float InnerConeCos;
-        public float OuterConeCos;
-    }
-
     public class TrItemLabel
     {
         public readonly WorldPosition Location;