WIP: Instance drawing

.gitignore

@@ -13,4 +13,5 @@ PublishProfiles
 plugin
 package
 .DS_Store
-*.user
+*.user
+/XPNetPluginTestHost/xpnetcfg.json

XPLMTestHarness/XPLMTestHarness.cpp

@@ -6,6 +6,7 @@
 #include "XPLMScenery.h"
 #include "XPLMGraphics.h"
 #include <map>
+#include <list>
 #include <tuple>
 #include <vector>
 #include <string>
@@ -118,6 +119,9 @@ static commandmap configuredCommands;
 static map<XPLMFlightLoop_f, flightloop> registeredFlightLoops;
 static map<tuple<XPLMDrawCallback_f, XPLMDrawingPhase, int>, drawcallback> registeredDrawCallbacks;
 
+static unsigned int instanceCounter = 0;
+static map<XPLMInstanceRef, std::list<string>> registeredInstances;
+
 template <typename T>
 void SetDataRef(const string name, const T& value, datarefmap<T>& container)
 {
@@ -608,6 +612,43 @@ XPLM_API void                 XPLMLocalToWorld(
 	*outLatitude = inZ;
 }
 
+XPLM_API XPLMInstanceRef XPLMCreateInstance(XPLMObjectRef obj, const char ** datarefs)
+{
+	instanceCounter++;
+	std::cout << "XPLMTestHarness: Creating instance for object " <<  obj << std::endl;
+	unsigned int i = 0;
+	std::list<string> dRefList;
+	for (i = 0; datarefs[i] != NULL; i++) {
+		std::cout << "XPLMTestHarness: DataRef " << datarefs[i]  << std::endl;
+		dRefList.push_back(datarefs[i]);
+	}
+	XPLMInstanceRef instRef = reinterpret_cast<XPLMInstanceRef>(static_cast<uintptr_t>(instanceCounter));
+	registeredInstances.emplace(instRef, dRefList);
+
+	return instRef;
+}
+
+XPLM_API void XPLMDestroyInstance(XPLMInstanceRef instance)
+{
+	std::cout << "XPLMTestHarness: Destroying instance " << instance << std::endl;
+	registeredInstances.erase(instance);
+}
+
+XPLM_API void XPLMInstanceSetPosition(XPLMInstanceRef instance, const XPLMDrawInfo_t * new_position, const float * data)
+{
+	std::cout << "XPLMTestHarness: Instance set position for instance " << instance << std::endl;
+	auto it = registeredInstances.find(instance);
+	if (it != registeredInstances.end()) {
+		auto datarefs = it->second;
+		unsigned int i = 0;
+		for (string dref : datarefs) {
+			std::cout << "XPLMTestHarness: DataRef " << dref << " set to value " << data[i++] << std::endl;
+		}
+	}
+}
+
+
+
 XPLM_API void XPHarnessInvokeFlightLoop(float elapsedSinceLastCall, float elapsedTimeSinceLastFlightLoop, int counter)
 {
 	// Before invoking clean up all the unregistered flight loops.

XPLMTestHarness/XPLMTestHarness.h

@@ -20,6 +20,7 @@
 #include "XPLMDataAccess.h"
 #include "XPLMProcessing.h"
 #include "XPLMDisplay.h"
+#include "XPLMInstance.h"
 #include "XPLMUtilities.h"
 
 typedef enum {

XPNet.CLR/Instance/XPlaneInstance.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace XPNet
+{
+	public interface IXPlaneInstance
+	{
+		void CreateInstance();
+		void DestroyInstance();
+	}
+
+	internal class XPlaneInstance : IXPlaneInstance
+	{
+		public void CreateInstance()
+		{
+			throw new NotImplementedException();
+		}
+
+		public void DestroyInstance()
+		{
+			throw new NotImplementedException();
+		}
+	}
+
+	public interface IXPInstance : IDisposable
+	{
+		void SetPosition(XPLMDrawInfo_t xPLMDrawInfo_t, IEnumerable<float> v);
+	}
+
+	internal unsafe class XPInstance : IXPInstance
+	{
+		readonly void* m_instanceRef;
+
+		public XPInstance(void* instanceRef)
+		{
+			m_instanceRef = instanceRef;
+		}
+
+		public void Dispose()
+		{
+			PluginBridge.ApiFunctions.XPLMDestroyInstance(m_instanceRef);
+		}
+
+		public void SetPosition(XPLMDrawInfo_t xPLMDrawInfo_t, IEnumerable<float> v)
+		{
+			var floatArray = v.ToArray();
+			fixed (float* p = &floatArray[0])
+			{
+				PluginBridge.ApiFunctions.XPLMInstanceSetPosition(m_instanceRef, xPLMDrawInfo_t, p);
+			}
+		}
+	}
+}

XPNet.CLR/Plugin/XPNetPluginBridge.cs

@@ -725,6 +725,26 @@ internal unsafe delegate int XPLMLocalToWorld
 	);
 
 	#endregion X-Plane Graphics API
+	#region X-Plane Instance API
+	internal unsafe delegate void* XPLMCreateInstance
+	(
+		void* inObj,
+		[MarshalAs(UnmanagedType.LPArray,
+   ArraySubType=UnmanagedType.LPStr)] string[] inDataRefs
+	);
+
+	internal unsafe delegate void XPLMDestroyInstance
+	(
+		void* instance
+	);
+
+	internal unsafe delegate void XPLMInstanceSetPosition
+	(
+		void* instance,
+		XPLMDrawInfo_t inNewPosition,
+		float* data
+	);
+	#endregion X-Plane Instance API
 
 	[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi, Pack = 2)]
 	public struct ApiFunctionPointers
@@ -779,6 +799,10 @@ public struct ApiFunctionPointers
 		internal IntPtr XPLMWorldToLocal;
 		internal IntPtr XPLMLocalToWorld;
 
+		// Instance
+		internal IntPtr XPLMCreateInstance;
+		internal IntPtr XPLMDestroyInstance;
+		internal IntPtr XPLMInstanceSetPosition;
 	}
 
 	public unsafe struct ApiFunctions
@@ -833,10 +857,14 @@ public ApiFunctions(ApiFunctionPointers p)
 			XPLMUnloadObject = Marshal.GetDelegateForFunctionPointer<XPLMUnloadObject>(p.XPLMUnloadObject);
 			XPLMLookupObjects = Marshal.GetDelegateForFunctionPointer<XPLMLookupObjects>(p.XPLMLookupObjects);
 
-
 			// Graphics
 			XPLMWorldToLocal = Marshal.GetDelegateForFunctionPointer<XPLMWorldToLocal>(p.XPLMWorldToLocal);
 			XPLMLocalToWorld = Marshal.GetDelegateForFunctionPointer<XPLMLocalToWorld>(p.XPLMLocalToWorld);
+
+			// InstanceDrawing
+			XPLMCreateInstance = Marshal.GetDelegateForFunctionPointer<XPLMCreateInstance>(p.XPLMCreateInstance);
+			XPLMDestroyInstance = Marshal.GetDelegateForFunctionPointer<XPLMDestroyInstance>(p.XPLMDestroyInstance);
+			XPLMInstanceSetPosition = Marshal.GetDelegateForFunctionPointer<XPLMInstanceSetPosition>(p.XPLMInstanceSetPosition);
 		}
 
 		// Data
@@ -889,6 +917,10 @@ public ApiFunctions(ApiFunctionPointers p)
 		internal XPLMWorldToLocal XPLMWorldToLocal;
 		internal XPLMLocalToWorld XPLMLocalToWorld;
 
+		// Instance
+		internal XPLMCreateInstance XPLMCreateInstance;
+		internal XPLMDestroyInstance XPLMDestroyInstance;
+		internal XPLMInstanceSetPosition XPLMInstanceSetPosition;
 	}
 
 	[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi, Pack = 2)]

XPNet.CLR/Scenery/XPlaneScenery.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace XPNet
 {
@@ -56,6 +57,7 @@ unsafe void Enumerator(string inFilePath, void* inRef)
 	public interface IXPSceneryObject : IDisposable
 	{
 		void Draw(int lighting, int earthRelativ, XPLMDrawInfo_t[] drawInfos);
+		IXPInstance CreateInstance(IEnumerable<string> inDataRefs);
 	}
 
 	internal unsafe class XPSceneryObject : IXPSceneryObject
@@ -71,6 +73,14 @@ public void Dispose()
 		{
 			PluginBridge.ApiFunctions.XPLMUnloadObject(m_objectRef);
 		}
+		public IXPInstance CreateInstance(IEnumerable<string> inDataRefs)
+		{
+			List<string> dataRefList = inDataRefs.ToList();
+			dataRefList.Add(null);
+			string[] dataRefArray = dataRefList.ToArray();
+			var instanceRef = PluginBridge.ApiFunctions.XPLMCreateInstance(m_objectRef, dataRefArray);
+			return new XPInstance(instanceRef);
+		}
 
 		public void Draw(int lighting, int earthRelative, XPLMDrawInfo_t[] drawInfos)
 		{

XPNet.GraphicsTestPlugin/GraphicsTestPlugin.cs

@@ -4,7 +4,7 @@
 namespace XPNet
 {
 	/// <summary>
-	/// This is a testbed for getting the graphics going.
+	/// This is a testbed for checking graphics functions
 	/// </summary>
 	[XPlanePlugin(
 		name: "GraphicsTestPlugin",
@@ -14,20 +14,22 @@ namespace XPNet
 	public class GraphicsTestPlugin : IXPlanePlugin
 	{
 		private const string TUGPATH = "lib/airport/vehicles/pushback/tug.obj";
-		//private const string TUGPATH = "lib/airport/vehicles/pushback/*.obj";
 		private readonly IXPlaneApi m_api;
 		private readonly IXPProbe m_probe;
 		private readonly IXPDrawingLoopHook m_drawingLoopHook;
-		private IXPFlightLoopHook m_flightLoopHook;
-		private IXPSceneryObject testTug;
+		private float m_tireAngle = 0;
+		private IXPFlightLoopHook m_firstFlightLoopHook;
+		private IXPFlightLoopHook m_tireTurning;
+		private IXPSceneryObject m_testTug;
+		private IXPInstance m_testTugInstance;
 
 		public GraphicsTestPlugin(IXPlaneApi api)
 		{
 			m_api = api ?? throw new ArgumentNullException(nameof(api));
 
 			m_api.Log.Log("GraphicsTestPlugin: Displaytest started");
 			m_drawingLoopHook = m_api.Display.RegisterDrawHook(DrawingHook, XPLMDrawingPhase.xplm_Phase_Airplanes, 0);
-			m_flightLoopHook = m_api.Processing.RegisterFlightLoopHook(FlightLoopTime.FromCycles(1), SimLoaded);
+			m_firstFlightLoopHook = m_api.Processing.RegisterFlightLoopHook(FlightLoopTime.FromCycles(1), SimLoaded);
 			m_api.Log.Log("GraphicsTestPlugin: And now create a probe");
 			m_probe = m_api.Scenery.CreateProbe();
 			m_api.Log.Log("GraphicsTestPlugin: Probe created");
@@ -36,13 +38,11 @@ public GraphicsTestPlugin(IXPlaneApi api)
 		public void Dispose()
 		{
 			// Clean up whatever we attached / registered for / etc.
-
-			m_drawingLoopHook.Dispose();
-			testTug.Dispose();
-			m_probe.Dispose();
-
-            if (m_flightLoopHook != null)
-                m_flightLoopHook.Dispose();
+			m_drawingLoopHook?.Dispose();
+			m_testTug?.Dispose();
+			m_tireTurning?.Dispose();
+			m_probe?.Dispose();
+			m_firstFlightLoopHook?.Dispose();
 		}
 
 		/// <summary>
@@ -54,21 +54,56 @@ public void Dispose()
 		/// </summary>
 		private FlightLoopTime SimLoaded(TimeSpan elapsedTimeSinceLastCall, TimeSpan elapsedTimeSinceLastFlightLoop, int counter)
 		{
-			m_api.Log.Log($"GraphicsTestPlugin: Loading objects with path {TUGPATH}");
+			m_api.Log.Log($"GraphicsTestPlugin: Entered SimLoaded flightloop (just called once)");
 
+			m_api.Log.Log($"GraphicsTestPlugin: Loading objects with path {TUGPATH}");
 			var tugs = m_api.Scenery.LookupObjects(TUGPATH, 0, 0);
 			foreach (var p in tugs)
 				m_api.Log.Log($"GraphicsTestPlugin: Filename: {p}");
 
-			testTug = m_api.Scenery.LoadObject(tugs.First());
-			m_api.Log.Log($"GraphicsTestPlugin: Loaded and still living, reference is {testTug}");
+			m_testTug = m_api.Scenery.LoadObject(tugs.First());
+			m_testTugInstance = m_testTug.CreateInstance(new string[]
+			{
+				"sim/graphics/animation/ground_traffic/tire_steer_deg"
+			});
+
+			m_tireTurning = m_api.Processing.RegisterFlightLoopHook(FlightLoopTime.FromCycles(1), TurnTheWheel);
 
-			m_flightLoopHook.Dispose();
-            m_flightLoopHook = null;
+			m_api.Log.Log($"Loaded and still living, reference is {m_testTug}");
+			m_firstFlightLoopHook.Dispose();
+			m_firstFlightLoopHook = null;
+			m_api.Log.Log($"GraphicsTestPlugin: Leaving SimLoaded flightloop");
 
 			return FlightLoopTime.Unscheduled;
 		}
 
+		private FlightLoopTime TurnTheWheel(TimeSpan elapsedTimeSinceLastCall, TimeSpan elapsedTimeSinceLastFlightLoop, int counter)
+		{
+			m_api.Log.Log($"GraphicsTestPlugin: Entering TurnTheWheel flightloop");
+			var (x, y, z) = m_api.Graphics.WorldToLocal(47.437644, 19.259498, 0);
+			var res = m_probe.ProbeTerrainXYZ((float)x, 0, (float)z);
+			m_api.Log.Log($"Probed terrain, got result {res.LocationY} with code {res.Result}");
+
+			var (lat, lon, alt) = m_api.Graphics.LocalToWorld(res.LocationX, res.LocationY, res.LocationZ);
+
+			m_testTugInstance.SetPosition(new XPLMDrawInfo_t((float)res.LocationX, (float)res.LocationY, (float)res.LocationZ, (float)0, (float)0, (float)0),
+				new float[] { m_tireAngle });
+
+			m_tireAngle++;
+			if (m_tireAngle > 45)
+			{
+				m_tireAngle -= 90;
+			}
+			m_api.Log.Log($"GraphicsTestPlugin: Leaving TurnTheWheel flightloop");
+
+			return FlightLoopTime.FromCycles(1);
+		}
+
+		/// <summary>
+		/// This hook is called for drawing an object. Be aware that this
+		/// is a deprecated way of drawing, but we still support it as long 
+		/// as the SDK supports it.
+		/// </summary>
 		private int DrawingHook(XPLMDrawingPhase inPhase, int inIsBefore)
 		{
 			m_api.Log.Log("GraphicsTestPlugin: Entering drawing hook");
@@ -79,7 +114,9 @@ private int DrawingHook(XPLMDrawingPhase inPhase, int inIsBefore)
 
 			var (lat, lon, alt) = m_api.Graphics.LocalToWorld(res.LocationX, res.LocationY, res.LocationZ);
 
-			testTug.Draw(0, 0, new XPLMDrawInfo_t[] { new XPLMDrawInfo_t(res.LocationX, res.LocationY, res.LocationZ, 0.0f, 0.0f, 0.0f) });
+			m_testTug.Draw(0, 0, new XPLMDrawInfo_t[] { new XPLMDrawInfo_t(res.LocationX, res.LocationY, res.LocationZ, 0.0f, 0.0f, 0.0f) });
+
+			m_api.Log.Log("GraphicsTestPlugin: Leaving drawing hook");
 			return 1;
 		}
 

XPNet.Native/XPNetPlugin.cpp

@@ -65,6 +65,11 @@ typedef int(*PXPLMLookupObjects)(const char*, float, float, XPLMLibraryEnumerato
 typedef void(*PXPLMWorldToLocal)(double, double, double, double*, double*, double*);
 typedef void(*PXPLMLocalToWorld)(double, double, double, double*, double*, double*);
 
+// Instance - X-Plane API Function Pointer Types
+typedef XPLMInstanceRef(*PXPLMCreateInstance)(XPLMObjectRef, const char**);
+typedef void(*PXPLMDestroyInstance)(XPLMInstanceRef);
+typedef void(*PXPLMInstanceSetPosition)(XPLMInstanceRef, const XPLMDrawInfo_t*, const float*);
+
 // Function types for calling into XPNet.PluginBridge in the CLR.
 typedef int (STDMETHODCALLTYPE *PXPluginStart)(void*, void*);
 typedef void (STDMETHODCALLTYPE *PXPluginStop)();
@@ -142,11 +147,15 @@ typedef struct
 	PXPLMUnloadObject XPLMUnloadObject;
 	PXPLMLookupObjects XPLMLookupObjects;
 
-
 	// Graphics
 	PXPLMWorldToLocal XPLMWorldToLocal;
 	PXPLMLocalToWorld XPLMLocalToWorld;
 
+	// Instance
+	PXPLMCreateInstance XPLMCreateInstance;
+	PXPLMDestroyInstance XPLMDestroyInstance;
+	PXPLMInstanceSetPosition XPLMInstanceSetPosition;
+
 } ApiFunctions;
 
 
@@ -298,7 +307,12 @@ XPNETPLUGIN_API int XPluginStart(char* outName, char* outSig, char* outDesc)
 
 		// Graphics
 		XPLMWorldToLocal,
-		XPLMLocalToWorld
+		XPLMLocalToWorld,
+
+		// Instance
+		XPLMCreateInstance,
+		XPLMDestroyInstance,
+		XPLMInstanceSetPosition
 	};
 
 	auto ret = ClrPluginStart(&sp, &api);