Light Management and Lag Compensation

CHANGELOG.md

@@ -7,8 +7,10 @@
 Built with Unity 2020.3.
 
 ### Added
+- Support for dynamic wires, also known as *Fast Flip* ([#330](https://github.com/freezy/VisualPinball.Engine/pull/330), [Documentation](https://docs.visualpinball.org/creators-guide/editor/wire-manager.html#dynamic)).
+- Component for light groups, allowing easy grouping of GI lamps. ([#330](https://github.com/freezy/VisualPinball.Engine/pull/330) ([Documentation](https://docs.visualpinball.org/creators-guide/manual/mechanisms/light-groups.html))).
 - Slingshot component ([#329](https://github.com/freezy/VisualPinball.Engine/pull/329), [Documentation](https://docs.visualpinball.org/creators-guide/manual/mechanisms/slingshots.html)).
-- Create insert meshes ([#320](https://github.com/freezy/VisualPinball.Engine/pull/320))
+- Create insert meshes ([#320](https://github.com/freezy/VisualPinball.Engine/pull/320)).
 - Full support for custom playfield meshes.
 - Remove Hybrid Renderer ([#316](https://github.com/freezy/VisualPinball.Engine/pull/316)).
 - Create and use Unity assets when importing ([#320](https://github.com/freezy/VisualPinball.Engine/pull/302)).
@@ -37,6 +39,7 @@ Built with Unity 2020.3.
 - Put game-, mesh-, collision- animation data into separate components ([#227](https://github.com/freezy/VisualPinball.Engine/pull/227), [Documentation](https://docs.visualpinball.org/creators-guide/editor/unity-components.html)). 
 
 ### Fixed
+- Lighting setup. It's now usable ([#330](https://github.com/freezy/VisualPinball.Engine/pull/330)).
 - Ball passing through collider plane and disappearing.
 - Alpha channel of color values is now correctly written ([#291](https://github.com/freezy/VisualPinball.Engine/pull/291)).
 - Layer names are correctly computed when importing a 10.6 file ([#291](https://github.com/freezy/VisualPinball.Engine/pull/291)).

VisualPinball.Engine/Game/Engines/GamelogicEngineCoil.cs

@@ -27,8 +27,8 @@ public class GamelogicEngineCoil : IGamelogicEngineDeviceItem
 		public string Description { get => _description; set => _description = value; }
 
 		public int InternalId;
-		public string DeviceHint;
-		public string DeviceItemHint;
+		public string DeviceHint { get => _deviceHint; set => _deviceHint = value; }
+		public string DeviceItemHint { get => _deviceItemHint; set => _deviceItemHint = value; }
 		public bool IsLamp;
 
 		/// <summary>
@@ -38,6 +38,8 @@ public class GamelogicEngineCoil : IGamelogicEngineDeviceItem
 
 		private string _description;
 		private string _id;
+		private string _deviceHint;
+		private string _deviceItemHint;
 
 		public GamelogicEngineCoil(string id)
 		{

VisualPinball.Engine/Game/Engines/GamelogicEngineLamp.cs

@@ -17,30 +17,78 @@
 // ReSharper disable InconsistentNaming
 
 using System;
+using VisualPinball.Engine.Math;
 
 namespace VisualPinball.Engine.Game.Engines
 {
 	[Serializable]
 	public class GamelogicEngineLamp : IGamelogicEngineDeviceItem
 	{
-	public string Id { get; set; }
-	public int InternalId;
-	public string Description { get; set; }
-	public string DeviceHint;
-	public string DeviceItemHint;
-	public string MainLampIdOfGreen;
-	public string MainLampIdOfBlue;
-
-	public GamelogicEngineLamp(string id)
-	{
-		Id = id;
-		InternalId = int.TryParse(id, out var internalId) ? internalId : 0;
+		/// <summary>
+		/// The unique ID of this lamp, as the gamelogic engine addresses it.
+		/// </summary>
+		public string Id { get => _id; set => _id = value; }
+
+		/// <summary>
+		/// Some gamelogic engines use integers for the ID. In order to avoid repetitive casting, we store it as integer as well.
+		/// </summary>
+		public int InternalId;
+
+		/// <summary>
+		/// Which channel this lamp corresponds to.
+		/// </summary>
+		public ColorChannel Channel = ColorChannel.Alpha;
+
+		/// <summary>
+		/// If it's a fading light, this is the value at maximal intensity.
+		/// </summary>
+		public int FadingSteps;
+
+		/// <summary>
+		/// An optional description of the lamp.
+		/// </summary>
+		public string Description { get => _description; set => _description = value; }
+
+		/// <summary>
+		/// How the gamelogic engine triggers the lamp. Either through GI or through the normal lamp API.
+		/// </summary>
+		///
+		/// <remarks>
+		/// Note that lamps connected to coils will appear under coils.
+		/// </remarks>
+		public LampSource Source = LampSource.Lamp;
+
+		/// <summary>
+		/// A regular expression to match the component on the playfield.
+		/// </summary>
+		public string DeviceHint { get => _deviceHint; set => _deviceHint = value; }
+
+		/// <summary>
+		/// A regular expression to match the lamp component within the component.
+		/// </summary>
+		public string DeviceItemHint { get => _deviceItemHint; set => _deviceItemHint = value; }
+
+		private string _description;
+		private string _id;
+		private string _deviceHint;
+		private string _deviceItemHint;
+
+		public GamelogicEngineLamp(string id)
+		{
+			Id = id;
+			InternalId = int.TryParse(id, out var internalId) ? internalId : 0;
+		}
+
+		public GamelogicEngineLamp(string id, int internalId)
+		{
+			Id = id;
+			InternalId = internalId;
+		}
 	}
 
-	public GamelogicEngineLamp(string id, int internalId)
+	public enum LampSource
 	{
-		Id = id;
-		InternalId = internalId;
-	}
+		Lamp = 0,
+		GI = 1,
 	}
 }

VisualPinball.Engine/Game/Engines/GamelogicEngineSwitch.cs

@@ -61,12 +61,15 @@ public class GamelogicEngineSwitch : IGamelogicEngineDeviceItem
 		public string Description { get => _description; set => _description = value; }
 		public string InputActionHint;
 		public string InputMapHint;
-		public string DeviceHint;
-		public string DeviceItemHint;
+
+		public string DeviceHint { get => _deviceHint; set => _deviceHint = value; }
+		public string DeviceItemHint { get => _deviceItemHint; set => _deviceItemHint = value; }
 		public SwitchConstantHint ConstantHint = SwitchConstantHint.None;
 
 		private string _description;
 		private string _id;
+		private string _deviceHint;
+		private string _deviceItemHint;
 
 		public GamelogicEngineSwitch(string id)
 		{

VisualPinball.Engine/Game/Engines/GamelogicEngineWire.cs

@@ -0,0 +1,44 @@
+// Visual Pinball Engine
+// Copyright (C) 2021 freezy and VPE Team
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+// ReSharper disable InconsistentNaming
+
+using System;
+
+namespace VisualPinball.Engine.Game.Engines
+{
+	[Serializable]
+	public class GamelogicEngineWire
+	{
+		public string Description;
+		public string SourceId;
+		public string DestinationId;
+		public DestinationType DestinationType;
+
+		public GamelogicEngineWire(string srcId, string destId, DestinationType type, string description = "")
+		{
+			Description = description;
+			SourceId = srcId;
+			DestinationId = destId;
+			DestinationType = type;
+		}
+	}
+
+	public enum DestinationType
+	{
+		Coil, Lamp, GI
+	}
+}

VisualPinball.Engine/Game/Engines/IGamelogicEngineDeviceItem.cs

@@ -20,5 +20,7 @@ public interface IGamelogicEngineDeviceItem
 	{
 		string Id { get; }
 		string Description { get; }
+		string DeviceHint { get; }
+		string DeviceItemHint { get; }
 	}
 }

VisualPinball.Engine/Math/Color.cs

@@ -98,7 +98,25 @@ public enum ColorFormat
 
 	public enum ColorChannel
 	{
-		Red, Green, Blue, Alpha
+		/// <summary>
+		/// The red channel for RGB lamps.
+		/// </summary>
+		Red,
+
+		/// <summary>
+		/// The green channel for RGB lamps.
+		/// </summary>
+		Green,
+
+		/// <summary>
+		/// The blue channel for RBG lamps.
+		/// </summary>
+		Blue,
+
+		/// <summary>
+		/// The intensity for white lamps.
+		/// </summary>
+		Alpha,
 	}
 
 	public static class Colors

VisualPinball.Engine/VPT/Light/Light.cs

@@ -14,6 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
+using System;
 using System.IO;
 using VisualPinball.Engine.Game;
 using VisualPinball.Engine.Math;
@@ -29,6 +30,8 @@ public class Light : Item<LightData>, IRenderable
 
 		private readonly LightMeshGenerator _meshGenerator;
 
+		public bool IsInsertLight(Table.Table table) => !Data.ShowBulbMesh && string.Equals(Data.OffImage, table.Data.Image, StringComparison.OrdinalIgnoreCase);
+
 		public Light(LightData data) : base(data)
 		{
 			_meshGenerator = new LightMeshGenerator(Data);
@@ -38,11 +41,9 @@ public Light(BinaryReader reader, string itemName) : this(new LightData(reader,
 		{
 		}
 
-		public static Light GetDefault(Table.Table table)
+		public static Light GetDefault(string name, float x, float y)
 		{
-			var x = table.Width / 2f;
-			var y = table.Height / 2f;
-			var lightData = new LightData(table.GetNewName<Light>("Light"), table.Width / 2f, table.Height / 2f) {
+			var lightData = new LightData(name, x, y) {
 				DragPoints = new[] {
 					new DragPointData(x, y - 50f) {IsSmooth = true },
 					new DragPointData(x - 50f * MathF.Cos(MathF.PI / 4), y - 50f * MathF.Sin(MathF.PI / 4)) {IsSmooth = true },
@@ -56,6 +57,8 @@ public static Light GetDefault(Table.Table table)
 			};
 			return new Light(lightData);
 		}
+
+		public static Light GetDefault(Table.Table table) => GetDefault(table.GetNewName<Light>("Light"), table.Width / 2f, table.Height / 2f);
 
 		#region IRenderable
 

VisualPinball.Engine/VPT/Material.cs

@@ -16,6 +16,7 @@
 
 #region ReSharper
 // ReSharper disable FieldCanBeMadeReadOnly.Global
+// ReSharper disable InconsistentNaming
 #endregion
 
 using System;
@@ -140,6 +141,7 @@ public Material(string name) : this()
 			BaseColor = new Color(255, 255, 255, 255);
 			Glossiness = new Color(0, 0, 0, 255);
 			ClearCoat = new Color(0, 0, 0, 255);
+			Opacity = 1f;
 
 			UpdateData();
 		}

VisualPinball.Engine/VPT/PbrMaterial.cs

@@ -39,6 +39,10 @@ public class PbrMaterial
 		public bool IsOpacityActive => _material?.IsOpacityActive ?? false;
 		public float Opacity => MathF.Min(1, MathF.Max(0, _material?.Opacity ?? 1f));
 		public float Roughness => _material?.Roughness ?? 0.5f;
+
+		public MaterialType MaterialType = MaterialType.Translucent;
+		public DiffusionProfileTemplate DiffusionProfile = DiffusionProfileTemplate.None;
+
 		private float Edge => _material?.Edge ?? 0f;
 
 		public const string NameNoMaterial = "__std";
@@ -155,4 +159,20 @@ public enum BlendMode
 		Cutout,
 		Translucent
 	}
+
+	public enum DiffusionProfileTemplate
+	{
+		None,
+		Plastics
+	}
+
+	public enum MaterialType
+	{
+		SubsurfaceScattering = 0,
+		Standard = 1,
+		Anisotropy = 2,
+		Iridescence = 3,
+		SpecularColor = 4,
+		Translucent = 5,
+	}
 }

VisualPinball.Engine/VPT/Table/TableMeshGenerator.cs

@@ -45,7 +45,9 @@ public Mesh GetMesh(Table table, bool asRightHanded = true)
 
 		public PbrMaterial GetMaterial(Table table)
 		{
-			return new PbrMaterial(table.GetMaterial(_data.PlayfieldMaterial), table.GetTexture(_data.Image));
+			return new PbrMaterial(table.GetMaterial(_data.PlayfieldMaterial), table.GetTexture(_data.Image)) {
+				MaterialType = MaterialType.Standard
+			};
 		}
 
 		public void SetFromPrimitive(Primitive.Primitive primitive)