Initial trough implementation

VisualPinball.Engine/VPT/ItemType.cs

@@ -49,7 +49,8 @@ public enum ItemType
 		Flasher = 20,
 		Rubber = 21,
 		HitTarget = 22,
-		Count = 23,
+		Trough = 23,
+		Count = 24,
 		Invalid = -1,
 
 		// VPE internal

VisualPinball.Engine/VPT/Trough/Trough.cs

@@ -0,0 +1,58 @@
+// Visual Pinball Engine
+// Copyright (C) 2020 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/>.
+
+using System.IO;
+using VisualPinball.Engine.Game;
+using VisualPinball.Engine.Math;
+
+namespace VisualPinball.Engine.VPT.Trough
+{
+	public class Trough : Item<TroughData>, IRenderable
+	{
+		public override string ItemName { get; } = "Trough";
+		public override string ItemGroupName { get; } = "Troughs";
+
+		public Vertex3D Position { get => Vertex3D.Zero; set { } }
+		public float RotationY { get => 0f; set { } }
+
+		public Trough(TroughData data) : base(data)
+		{
+		}
+
+		public Trough(BinaryReader reader, string itemName) : this(new TroughData(reader, itemName))
+		{
+		}
+
+		#region IRenderable
+
+		Matrix3D IRenderable.TransformationMatrix(Table.Table table, Origin origin)
+		{
+			return Matrix3D.Identity;
+		}
+
+		public RenderObject GetRenderObject(Table.Table table, string id = null, Origin origin = Origin.Global, bool asRightHanded = true)
+		{
+			return null;
+		}
+
+		public RenderObjectGroup GetRenderObjects(Table.Table table, Origin origin = Origin.Global, bool asRightHanded = true)
+		{
+			return new RenderObjectGroup(Data.Name, "trough", Math.Matrix3D.Identity, new RenderObject[0]);
+		}
+
+		#endregion
+	}
+}

VisualPinball.Engine/VPT/Trough/TroughData.cs

@@ -0,0 +1,83 @@
+// Visual Pinball Engine
+// Copyright (C) 2020 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/>.
+
+#region ReSharper
+// ReSharper disable UnassignedField.Global
+// ReSharper disable StringLiteralTypo
+// ReSharper disable FieldCanBeMadeReadOnly.Global
+// ReSharper disable ConvertToConstant.Global
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using VisualPinball.Engine.IO;
+using VisualPinball.Engine.Math;
+using VisualPinball.Engine.VPT.Table;
+
+namespace VisualPinball.Engine.VPT.Trough
+{
+	[Serializable]
+	public class TroughData : ItemData
+	{
+		public override string GetName() => Name;
+		public override void SetName(string name) { Name = name; }
+
+		[BiffString("NAME", IsWideString = true, Pos = 9)]
+		public string Name;
+
+		[BiffString("ENTK", Pos = 1)]
+		public string EntryKicker = string.Empty;
+
+		[BiffString("ENTS", Pos = 2)]
+		public string EntrySwitch = string.Empty;
+
+		[BiffString("EXIT", Pos = 10)]
+		public string ExitKicker = string.Empty;
+
+		[BiffInt("BCNT", Pos = 3)]
+		public int BallCount = 3;
+
+		[BiffInt("SCNT", Pos = 4)]
+		public int SwitchCount = 3;
+
+		[BiffFloat("TIME", Pos = 5)]
+		public float SettleTime = 0.1f;
+
+		#region BIFF
+
+		static TroughData()
+		{
+			Init(typeof(TroughData), Attributes);
+		}
+
+		public TroughData(BinaryReader reader, string storageName) : base(storageName)
+		{
+			Load(this, reader, Attributes);
+		}
+
+		public override void Write(BinaryWriter writer, HashWriter hashWriter)
+		{
+			writer.Write((int)ItemType.Trough);
+			WriteRecord(writer, Attributes, hashWriter);
+			WriteEnd(writer, hashWriter);
+		}
+
+		private static readonly Dictionary<string, List<BiffAttribute>> Attributes = new Dictionary<string, List<BiffAttribute>>();
+
+		#endregion
+	}
+}

VisualPinball.Unity/VisualPinball.Unity.Editor/VPT/ItemInspector.cs

@@ -18,7 +18,9 @@
 using System.Linq;
 using UnityEditor;
 using UnityEngine;
+using VisualPinball.Engine.Game;
 using VisualPinball.Engine.Math;
+using VisualPinball.Engine.VPT;
 using VisualPinball.Engine.VPT.Surface;
 
 namespace VisualPinball.Unity.Editor
@@ -28,7 +30,7 @@ public abstract class ItemInspector : UnityEditor.Editor
 		public abstract MonoBehaviour UndoTarget { get; }
 
 		private TableAuthoring _table;
-		private SurfaceAuthoring _surface;
+		private MonoBehaviour _item;
 
 		private string[] _allMaterials = new string[0];
 		private string[] _allTextures = new string[0];
@@ -238,28 +240,35 @@ protected void ItemDataField(string label, ref Engine.Math.Color field, bool dir
 			}
 		}
 
-		protected void SurfaceField(string label, ref string field, bool dirtyMesh = true)
+		protected void ItemReferenceField<TItemAuthoring, TItem, TData>(string label, ref string field, bool dirtyMesh = true)
+			where TItemAuthoring : ItemMainAuthoring<TItem, TData>
+			where TData : ItemData where TItem : Item<TData>, IRenderable
 		{
-			if (_surface?.name != field) {
-				_surface = null;
+			if (_item?.name != field) {
+				_item = null;
 			}
 
-			if (_surface == null && _table != null) {
-				var currentFieldName = field;
-				if (currentFieldName != null && _table.Table.Has<Surface>(currentFieldName)) {
-					_surface = _table.gameObject.GetComponentsInChildren<SurfaceAuthoring>(true)
+			if (_item == null && _table != null) {
+				string currentFieldName = field;
+				if (currentFieldName != null && _table.Table.Has<TItem>(currentFieldName)) {
+					_item = _table.gameObject.GetComponentsInChildren<TItemAuthoring>(true)
 						.FirstOrDefault(s => s.name == currentFieldName);
 				}
 			}
 
 			EditorGUI.BeginChangeCheck();
-			_surface = (SurfaceAuthoring)EditorGUILayout.ObjectField(label, _surface, typeof(SurfaceAuthoring), true);
+			_item = (TItemAuthoring)EditorGUILayout.ObjectField(label, _item, typeof(TItemAuthoring), true);
 			if (EditorGUI.EndChangeCheck()) {
 				FinishEdit(label, dirtyMesh);
-				field = _surface != null ? _surface.name : string.Empty;
+				field = _item != null ? _item.name : string.Empty;
 			}
 		}
 
+		protected void SurfaceField(string label, ref string field, bool dirtyMesh = true)
+		{
+			ItemReferenceField<SurfaceAuthoring, Surface, SurfaceData>(label, ref field, dirtyMesh);
+		}
+
 		protected void DropDownField<T>(string label, ref T field, string[] optionStrings, T[] optionValues, bool dirtyMesh = true, Action<T, T> onChanged = null) where T : IEquatable<T>
 		{
 			if (optionStrings == null || optionValues == null || optionStrings.Length != optionValues.Length) {

VisualPinball.Unity/VisualPinball.Unity.Editor/VPT/Trough/TroughInspector.cs

@@ -0,0 +1,57 @@
+// Visual Pinball Engine
+// Copyright (C) 2020 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/>.
+
+using UnityEditor;
+using VisualPinball.Unity;
+using VisualPinball.Engine.VPT.Trough;
+using VisualPinball.Engine.VPT.Kicker;
+
+namespace VisualPinball.Unity.Editor
+{
+	[CustomEditor(typeof(TroughAuthoring))]
+	public class TroughInspector : ItemMainInspector<Trough, TroughData, TroughAuthoring>
+	{
+		private TroughAuthoring _trough;
+		private bool _foldoutPosition = true;
+		private bool _foldoutMisc = true;
+
+		protected override void OnEnable()
+		{
+			base.OnEnable();
+			_trough = target as TroughAuthoring;
+		}
+
+		public override void OnInspectorGUI()
+		{
+			OnPreInspectorGUI();
+
+			if (_foldoutPosition = EditorGUILayout.BeginFoldoutHeaderGroup(_foldoutPosition, "Position")) {
+				ItemReferenceField<KickerAuthoring, Kicker, KickerData>("Entry Kicker", ref _trough.Data.EntryKicker);
+				ItemReferenceField<KickerAuthoring, Kicker, KickerData>("Exit Kicker", ref _trough.Data.ExitKicker);
+			}
+			EditorGUILayout.EndFoldoutHeaderGroup();
+
+			if (_foldoutMisc = EditorGUILayout.BeginFoldoutHeaderGroup(_foldoutMisc, "Misc")) {
+				ItemDataField("Max Balls", ref _trough.Data.BallCount, dirtyMesh: false);
+				ItemDataField("Switch Count", ref _trough.Data.SwitchCount, dirtyMesh: false);
+				ItemDataField("Settle Time", ref _trough.Data.SettleTime, dirtyMesh: false);
+			}
+			EditorGUILayout.EndFoldoutHeaderGroup();
+
+			base.OnInspectorGUI();
+		}
+	}
+}

VisualPinball.Unity/VisualPinball.Unity/Game/Player.cs

@@ -37,13 +37,15 @@
 using VisualPinball.Engine.VPT.Surface;
 using VisualPinball.Engine.VPT.Table;
 using VisualPinball.Engine.VPT.Trigger;
+using VisualPinball.Engine.VPT.Trough;
 using Logger = NLog.Logger;
 
 namespace VisualPinball.Unity
 {
 	public class Player : MonoBehaviour
 	{
 		public Table Table { get; private set; }
+		public TableApi TableApi { get { return _tableApi; } }
 
 		// shortcuts
 		public Matrix4x4 TableToWorld => transform.localToWorldMatrix;
@@ -258,6 +260,12 @@ public void RegisterTrigger(Trigger trigger, Entity entity, GameObject go)
 			_switches[trigger.Name] = triggerApi;
 		}
 
+		public void RegisterTrough(Trough trough, Entity entity, GameObject go)
+		{
+			var troughApi = new TroughApi(trough, entity, this);
+			_initializables.Add(troughApi);
+		}
+
 		#endregion
 
 		#region Mapping

VisualPinball.Unity/VisualPinball.Unity/VPT/ItemApi.cs

@@ -30,6 +30,7 @@ public abstract class ItemApi<T, TData> : IApi where T : Item<TData> where TData
 
 		protected TData Data => Item.Data;
 		protected Table Table => _player.Table;
+		protected TableApi TableApi => _player.TableApi;
 
 		protected readonly EntityManager EntityManager = World.DefaultGameObjectInjectionWorld.EntityManager;