feat(*): partially implement materialization API

Author: lmichaelis

ZenKit/Boxes.cs

@@ -2,17 +2,34 @@
 using System.Collections.Generic;
 using System.Numerics;
 using System.Runtime.InteropServices;
+using ZenKit.Util;
 
 namespace ZenKit
 {
+	[Serializable]
 	[StructLayout(LayoutKind.Sequential)]
 	public struct AxisAlignedBoundingBox
 	{
 		public Vector3 Min;
 		public Vector3 Max;
 	}
 
-	public class OrientedBoundingBox
+	namespace Materialized
+	{
+		[Serializable]
+		public struct OrientedBoundingBox
+		{
+			public Vector3 Center;
+			public Tuple<Vector3, Vector3, Vector3> Axes;
+			public Vector3 HalfWidth;
+			public List<OrientedBoundingBox> Children;
+		}
+	}
+
+	/// <summary>
+	///     The interface to native oriented bounding boxes.
+	/// </summary>
+	public class OrientedBoundingBox : IMaterializing<Materialized.OrientedBoundingBox>
 	{
 		private readonly UIntPtr _handle;
 
@@ -48,6 +65,22 @@ public List<OrientedBoundingBox> Children
 			}
 		}
 
+		/// <summary>
+		///     Fully loads this native object into a C# serializable object, disassociated
+		///     from the underlying native implementation.
+		/// </summary>
+		/// <returns>This native object in a pure C# representation.</returns>
+		public Materialized.OrientedBoundingBox Materialize()
+		{
+			return new Materialized.OrientedBoundingBox
+			{
+				Center = Center,
+				HalfWidth = HalfWidth,
+				Axes = Axes,
+				Children = Children.ConvertAll(obb => obb.Materialize())
+			};
+		}
+
 		public OrientedBoundingBox GetChild(ulong i)
 		{
 			var handle = Native.ZkOrientedBoundingBox_getChild(_handle, i);

ZenKit/BspTree.cs

@@ -2,15 +2,18 @@
 using System.Collections.Generic;
 using System.Numerics;
 using System.Runtime.InteropServices;
+using ZenKit.Util;
 
 namespace ZenKit
 {
+	[Serializable]
 	public enum BspTreeType
 	{
 		Indoor = 0,
 		Outdoor = 1
 	}
 
+	[Serializable]
 	[StructLayout(LayoutKind.Sequential, Size = 60)]
 	public struct BspNode
 	{
@@ -23,7 +26,31 @@ public struct BspNode
 		public int ParentIndex;
 	}
 
-	public class BspSector
+	namespace Materialized
+	{
+		[Serializable]
+		public struct BspSector
+		{
+			public string Name;
+			public uint[] NodeIndices;
+			public uint[] PortalPolygonIndices;
+		}
+
+		[Serializable]
+		public struct BspTree
+		{
+			public BspTreeType Type;
+			public uint[] PolygonIndices;
+			public uint[] LeafPolygonIndices;
+			public uint[] PortalPolygonIndices;
+			public Vector3[] LightPoints;
+			public ulong[] LeafNodeIndices;
+			public BspNode[] Nodes;
+			public List<BspSector> Sectors;
+		}
+	}
+
+	public class BspSector : IMaterializing<Materialized.BspSector>
 	{
 		private readonly UIntPtr _handle;
 
@@ -35,13 +62,29 @@ internal BspSector(UIntPtr handle)
 		public string Name => Native.ZkBspSector_getName(_handle).MarshalAsString() ??
 		                      throw new Exception("Failed to load bsp sector name");
 
-		public uint[] NodeIndices => Native.ZkBspSector_getNodeIndices(_handle, out var count).MarshalAsArray<uint>(count);
+		public uint[] NodeIndices =>
+			Native.ZkBspSector_getNodeIndices(_handle, out var count).MarshalAsArray<uint>(count);
 
 		public uint[] PortalPolygonIndices =>
 			Native.ZkBspSector_getPortalPolygonIndices(_handle, out var count).MarshalAsArray<uint>(count);
+
+		/// <summary>
+		///     Fully loads this native object into a C# serializable object, disassociated
+		///     from the underlying native implementation.
+		/// </summary>
+		/// <returns>This native object in a pure C# representation.</returns>
+		public Materialized.BspSector Materialize()
+		{
+			return new Materialized.BspSector
+			{
+				Name = Name,
+				NodeIndices = NodeIndices,
+				PortalPolygonIndices = PortalPolygonIndices
+			};
+		}
 	}
 
-	public class BspTree
+	public class BspTree : IMaterializing<Materialized.BspTree>
 	{
 		private readonly UIntPtr _handle;
 
@@ -86,6 +129,26 @@ public List<BspSector> Sectors
 			}
 		}
 
+		/// <summary>
+		///     Fully loads this native object into a C# serializable object, disassociated
+		///     from the underlying native implementation.
+		/// </summary>
+		/// <returns>This native object in a pure C# representation.</returns>
+		public Materialized.BspTree Materialize()
+		{
+			return new Materialized.BspTree
+			{
+				Type = Type,
+				PolygonIndices = PolygonIndices,
+				LeafPolygonIndices = LeafPolygonIndices,
+				PortalPolygonIndices = PortalPolygonIndices,
+				LightPoints = LightPoints,
+				LeafNodeIndices = LeafNodeIndices,
+				Nodes = Nodes,
+				Sectors = Sectors.ConvertAll(sector => sector.Materialize())
+			};
+		}
+
 		public BspSector GetSector(ulong i)
 		{
 			return new BspSector(Native.ZkBspTree_getSector(_handle, i));

ZenKit/CutsceneLibrary.cs

@@ -1,9 +1,34 @@
 using System;
 using System.Collections.Generic;
+using ZenKit.Util;
 
 namespace ZenKit
 {
-	public class CutsceneMessage
+	namespace Materialized
+	{
+		[Serializable]
+		public struct CutsceneMessage
+		{
+			public uint Type;
+			public string Text;
+			public string Name;
+		}
+
+		[Serializable]
+		public struct CutsceneBlock
+		{
+			public string Name;
+			public CutsceneMessage Message;
+		}
+
+		[Serializable]
+		public struct CutsceneLibrary
+		{
+			public List<CutsceneBlock> Blocks;
+		}
+	}
+
+	public class CutsceneMessage : IMaterializing<Materialized.CutsceneMessage>
 	{
 		private readonly UIntPtr _handle;
 
@@ -19,9 +44,19 @@ internal CutsceneMessage(UIntPtr handle)
 
 		public string Name => Native.ZkCutsceneMessage_getName(_handle).MarshalAsString() ??
 		                      throw new Exception("Failed to get cutscene message name");
+
+		public Materialized.CutsceneMessage Materialize()
+		{
+			return new Materialized.CutsceneMessage
+			{
+				Type = Type,
+				Text = Text,
+				Name = Name
+			};
+		}
 	}
 
-	public class CutsceneBlock
+	public class CutsceneBlock : IMaterializing<Materialized.CutsceneBlock>
 	{
 		private readonly UIntPtr _handle;
 
@@ -43,9 +78,18 @@ public CutsceneMessage Message
 					: throw new Exception("Failed to load cutscene block message");
 			}
 		}
+
+		public Materialized.CutsceneBlock Materialize()
+		{
+			return new Materialized.CutsceneBlock
+			{
+				Name = Name,
+				Message = Message.Materialize()
+			};
+		}
 	}
 
-	public class CutsceneLibrary
+	public class CutsceneLibrary : IMaterializing<Materialized.CutsceneLibrary>
 	{
 		private readonly UIntPtr _handle;
 
@@ -83,6 +127,14 @@ public List<CutsceneBlock> Blocks
 			}
 		}
 
+		public Materialized.CutsceneLibrary Materialize()
+		{
+			return new Materialized.CutsceneLibrary
+			{
+				Blocks = Blocks.ConvertAll(block => block.Materialize())
+			};
+		}
+
 		~CutsceneLibrary()
 		{
 			Native.ZkCutsceneLibrary_del(_handle);

ZenKit/DaedalusInstance.cs

@@ -1,9 +1,12 @@
 using System;
 using ZenKit.Daedalus;
+using ZenKit.Util;
 
 namespace ZenKit
 {
-	public enum DaedalusInstanceType {
+	[Serializable]
+	public enum DaedalusInstanceType
+	{
 		GuildValues = 0,
 		Npc = 1,
 		Mission = 2,
@@ -25,12 +28,22 @@ public enum DaedalusInstanceType {
 		FightAi = 18,
 		SoundEffect = 19,
 		SoundSystem = 20,
-		Invalid = 20,
+		Invalid = 20
+	}
+
+	namespace Materialized
+	{
+		[Serializable]
+		public struct DaedalusInstance
+		{
+			public DaedalusInstanceType Type;
+			public uint Index;
+		}
 	}
 
-	public class DaedalusInstance
+	public class DaedalusInstance : IMaterializing<Materialized.DaedalusInstance>
 	{
-		public DaedalusInstance(UIntPtr handle)
+		protected DaedalusInstance(UIntPtr handle)
 		{
 			Handle = handle;
 		}
@@ -40,6 +53,15 @@ public DaedalusInstance(UIntPtr handle)
 		public DaedalusInstanceType Type => Native.ZkDaedalusInstance_getType(Handle);
 		public uint Index => Native.ZkDaedalusInstance_getIndex(Handle);
 
+		public Materialized.DaedalusInstance Materialize()
+		{
+			return new Materialized.DaedalusInstance
+			{
+				Type = Type,
+				Index = Index
+			};
+		}
+
 		public static DaedalusInstance FromNative(UIntPtr handle)
 		{
 			return Native.ZkDaedalusInstance_getType(handle) switch
@@ -64,9 +86,10 @@ public static DaedalusInstance FromNative(UIntPtr handle)
 				DaedalusInstanceType.FightAi => new FightAiInstance(handle),
 				DaedalusInstanceType.SoundEffect => new SoundEffectInstance(handle),
 				DaedalusInstanceType.SoundSystem => new SoundSystemInstance(handle),
-				DaedalusInstanceType.Svm => throw new InvalidOperationException("Svm Instances are currently not supported"),
+				DaedalusInstanceType.Svm => throw new InvalidOperationException(
+					"Svm Instances are currently not supported"),
 				_ => new DaedalusInstance(handle)
 			};
 		}
 	}
-}
+}

ZenKit/Font.cs

@@ -2,9 +2,11 @@
 using System.Collections.Generic;
 using System.Numerics;
 using System.Runtime.InteropServices;
+using ZenKit.Util;
 
 namespace ZenKit
 {
+	[Serializable]
 	[StructLayout(LayoutKind.Sequential)]
 	public struct FontGlyph
 	{
@@ -13,7 +15,18 @@ public struct FontGlyph
 		public Vector2 bottomRight;
 	}
 
-	public class Font
+	namespace Materialized
+	{
+		[Serializable]
+		public struct Font
+		{
+			public string Name;
+			public uint Height;
+			public List<FontGlyph> Glyphs;
+		}
+	}
+
+	public class Font : IMaterializing<Materialized.Font>
 	{
 		private readonly UIntPtr _handle;
 
@@ -58,6 +71,16 @@ public List<FontGlyph> Glyphs
 			}
 		}
 
+		public Materialized.Font Materialize()
+		{
+			return new Materialized.Font
+			{
+				Name = Name,
+				Height = Height,
+				Glyphs = Glyphs
+			};
+		}
+
 		~Font()
 		{
 			Native.ZkFont_del(_handle);

ZenKit/GameVersion.cs

@@ -1,5 +1,8 @@
+using System;
+
 namespace ZenKit
 {
+	[Serializable]
 	public enum GameVersion
 	{
 		Gothic1 = 0,