Merge pull request #6989 from keveleigh/refactor-wmrutilities

Refactor WMRUtilities to support Unity legacy XR and XR SDK

Author: keveleigh

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/Definitions/HolographicFrameNativeData.cs

@@ -24,12 +24,12 @@ public struct HolographicFrameNativeData
         public uint MaxNumberOfCameras;
 
         /// <summary>
-        /// The current native root <see href="https://docs.microsoft.com/uwp/api/windows.perception.spatial.spatialcoordinatesystem">ISpatialCoordinateSystem</see>).
+        /// The current native root <see href="https://docs.microsoft.com/uwp/api/windows.perception.spatial.spatialcoordinatesystem">ISpatialCoordinateSystem</see>.
         /// </summary>
         public IntPtr ISpatialCoordinateSystemPtr;
 
         /// <summary>
-        /// The current native <see href="https://docs.microsoft.com/uwp/api/Windows.Graphics.Holographic.HolographicFrame">IHolographicFrame</see>).
+        /// The current native <see href="https://docs.microsoft.com/uwp/api/Windows.Graphics.Holographic.HolographicFrame">IHolographicFrame</see>.
         /// </summary>
         public IntPtr IHolographicFramePtr;
 

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/Shared/Definitions/IWindowsMixedRealityUtilitiesProvider.cs

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+
+namespace Microsoft.MixedReality.Toolkit.WindowsMixedReality
+{
+    /// <summary>
+    /// Defines a set of IntPtr properties that are used by the static <see cref="WindowsMixedRealityUtilities"/>
+    /// to provide access to specific underlying native objects relevant to Windows Mixed Reality.
+    /// </summary>
+    /// <remarks>
+    /// This is intended to be used to support both XR SDK and Unity's legacy XR pipeline, which provide
+    /// different APIs to access these native objects.
+    /// </remarks>
+    public interface IWindowsMixedRealityUtilitiesProvider
+    {
+        /// <summary>
+        /// The current native root <see href="https://docs.microsoft.com/uwp/api/windows.perception.spatial.spatialcoordinatesystem">ISpatialCoordinateSystem</see>.
+        /// </summary>
+        IntPtr ISpatialCoordinateSystemPtr { get; }
+
+        /// <summary>
+        /// The current native <see href="https://docs.microsoft.com/uwp/api/Windows.Graphics.Holographic.HolographicFrame">IHolographicFrame</see>.
+        /// </summary>
+        IntPtr IHolographicFramePtr { get; }
+    }
+}

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/Shared/Definitions/IWindowsMixedRealityUtilitiesProvider.cs.meta

@@ -31,7 +31,7 @@ private void OnPostRender()
             if (isDepthReprojectionModeSupported &&
                 (ReprojectionMethod == HolographicDepthReprojectionMethod.AutoPlanar))
             {
-                Microsoft.Windows.Graphics.Holographic.HolographicFrame frame = Input.WindowsMixedRealityUtilities.CurrentHolographicFrame;
+                Microsoft.Windows.Graphics.Holographic.HolographicFrame frame = WindowsMixedRealityUtilities.CurrentHolographicFrame;
                 foreach (var cameraPose in frame?.CurrentPrediction.CameraPoses)
                 {
                     if (CameraSupportsAutoPlanar(cameraPose.HolographicCamera))

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/Shared/WindowsMixedRealityReprojectionUpdater.cs

@@ -4,7 +4,6 @@
 #if (UNITY_WSA && DOTNETWINRT_PRESENT) || WINDOWS_UWP
 using System;
 using System.Runtime.InteropServices;
-using UnityEngine.XR.WSA;
 #if WINDOWS_UWP
 using Windows.Perception.Spatial;
 #if DOTNETWINRT_PRESENT
@@ -18,7 +17,7 @@
 #endif
 #endif // (UNITY_WSA && DOTNETWINRT_PRESENT) || WINDOWS_UWP
 
-namespace Microsoft.MixedReality.Toolkit.WindowsMixedReality.Input
+namespace Microsoft.MixedReality.Toolkit.WindowsMixedReality
 {
     public static class WindowsMixedRealityUtilities
     {
@@ -40,7 +39,8 @@ private static SpatialCoordinateSystem GetSpatialCoordinateSystem(IntPtr nativeP
         {
             try
             {
-                GetSpatialCoordinateSystem(nativePtr, out SpatialCoordinateSystem coordinateSystem);
+                SpatialCoordinateSystem coordinateSystem;
+                GetSpatialCoordinateSystem(nativePtr, out coordinateSystem);
                 return coordinateSystem;
             }
             catch
@@ -51,6 +51,8 @@ private static SpatialCoordinateSystem GetSpatialCoordinateSystem(IntPtr nativeP
         }
 #endif //ENABLE_DOTNET
 
+        public static IWindowsMixedRealityUtilitiesProvider UtilitiesProvider { get; set; } = null;
+
         /// <summary>
         /// Access the underlying native spatial coordinate system.
         /// </summary>
@@ -62,18 +64,17 @@ public static SpatialCoordinateSystem SpatialCoordinateSystem
         {
             get
             {
+                if (spatialCoordinateSystem == null && UtilitiesProvider != null)
+                {
 #if ENABLE_DOTNET
-                return spatialCoordinateSystem ?? (spatialCoordinateSystem = GetSpatialCoordinateSystem(WorldManager.GetNativeISpatialCoordinateSystemPtr()));
+                    spatialCoordinateSystem = GetSpatialCoordinateSystem(UtilitiesProvider.ISpatialCoordinateSystemPtr);
 #elif WINDOWS_UWP
-                return spatialCoordinateSystem ?? (spatialCoordinateSystem = Marshal.GetObjectForIUnknown(WorldManager.GetNativeISpatialCoordinateSystemPtr()) as SpatialCoordinateSystem);
+                    spatialCoordinateSystem = Marshal.GetObjectForIUnknown(UtilitiesProvider.ISpatialCoordinateSystemPtr) as SpatialCoordinateSystem;
 #elif DOTNETWINRT_PRESENT
-                var spatialCoordinateSystemPtr = WorldManager.GetNativeISpatialCoordinateSystemPtr();
-                if (spatialCoordinateSystem == null && spatialCoordinateSystemPtr != IntPtr.Zero)
-                {
-                    spatialCoordinateSystem = SpatialCoordinateSystem.FromNativePtr(WorldManager.GetNativeISpatialCoordinateSystemPtr());
+                    spatialCoordinateSystem = SpatialCoordinateSystem.FromNativePtr(UtilitiesProvider.ISpatialCoordinateSystemPtr);
+#endif
                 }
                 return spatialCoordinateSystem;
-#endif
             }
         }
 
@@ -88,14 +89,15 @@ public static HolographicFrame CurrentHolographicFrame
         {
             get
             {
+                if (UtilitiesProvider == null)
+                {
+                    return null;
+                }
+
 #if DOTNETWINRT_PRESENT
-                IntPtr nativePtr = UnityEngine.XR.XRDevice.GetNativePtr();
-                HolographicFrameNativeData hfd = Marshal.PtrToStructure<HolographicFrameNativeData>(nativePtr);
-                return HolographicFrame.FromNativePtr(hfd.IHolographicFramePtr);
+                return HolographicFrame.FromNativePtr(UtilitiesProvider.IHolographicFramePtr);
 #elif WINDOWS_UWP
-                IntPtr nativePtr = UnityEngine.XR.XRDevice.GetNativePtr();
-                HolographicFrameNativeData hfd = Marshal.PtrToStructure<HolographicFrameNativeData>(nativePtr);
-                return Marshal.GetObjectForIUnknown(hfd.IHolographicFramePtr) as HolographicFrame;
+                return Marshal.GetObjectForIUnknown(UtilitiesProvider.IHolographicFramePtr) as HolographicFrame;
 #else
                 return null;
 #endif

…dReality/WindowsMixedRealityUtilities.cs …y/Shared/WindowsMixedRealityUtilities.csAssets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityUtilities.cs renamed to Assets/MixedRealityToolkit.Providers/WindowsMixedReality/Shared/WindowsMixedRealityUtilities.cs Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityUtilities.cs renamed to Assets/MixedRealityToolkit.Providers/WindowsMixedReality/Shared/WindowsMixedRealityUtilities.cs

@@ -5,9 +5,8 @@
 using Microsoft.MixedReality.Toolkit.Input;
 using Microsoft.MixedReality.Toolkit.Windows.Input;
 using Microsoft.MixedReality.Toolkit.Windows.Utilities;
-using UnityEngine;
 using System;
-using Microsoft.MixedReality.Toolkit.Utilities.Editor;
+using UnityEngine;
 
 #if UNITY_WSA
 using System.Collections.Generic;
@@ -99,7 +98,6 @@ public bool CheckCapability(MixedRealityCapability capability)
         #endregion IMixedRealityCapabilityCheck Implementation
 
 #if UNITY_WSA
-
         /// <summary>
         /// The initial size of interactionmanagerStates.
         /// </summary>
@@ -321,6 +319,13 @@ public override void Enable()
 
             if (InputSystemProfile == null) { return; }
 
+#if (UNITY_WSA && DOTNETWINRT_PRESENT) || WINDOWS_UWP
+            if (WindowsMixedRealityUtilities.UtilitiesProvider == null)
+            {
+                WindowsMixedRealityUtilities.UtilitiesProvider = new WindowsMixedRealityUtilitiesProvider();
+            }
+#endif // (UNITY_WSA && DOTNETWINRT_PRESENT) || WINDOWS_UWP
+
             if (InputSystemProfile.GesturesProfile != null)
             {
                 var gestureProfile = InputSystemProfile.GesturesProfile;

…ity/WindowsMixedRealityUtilities.cs.meta …red/WindowsMixedRealityUtilities.cs.metaAssets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityUtilities.cs.meta renamed to Assets/MixedRealityToolkit.Providers/WindowsMixedReality/Shared/WindowsMixedRealityUtilities.cs.meta Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityUtilities.cs.meta renamed to Assets/MixedRealityToolkit.Providers/WindowsMixedReality/Shared/WindowsMixedRealityUtilities.cs.meta

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using System.Runtime.InteropServices;
+
+#if UNITY_WSA
+using UnityEngine.XR.WSA;
+#endif // UNITY_WSA
+
+namespace Microsoft.MixedReality.Toolkit.WindowsMixedReality
+{
+    public class WindowsMixedRealityUtilitiesProvider : IWindowsMixedRealityUtilitiesProvider
+    {
+        /// <inheritdoc />
+        IntPtr IWindowsMixedRealityUtilitiesProvider.ISpatialCoordinateSystemPtr => 
+#if UNITY_WSA
+            WorldManager.GetNativeISpatialCoordinateSystemPtr();
+#else
+            IntPtr.Zero;
+#endif
+
+        /// <inheritdoc />
+        IntPtr IWindowsMixedRealityUtilitiesProvider.IHolographicFramePtr
+        {
+            get
+            {
+                IntPtr nativePtr = UnityEngine.XR.XRDevice.GetNativePtr();
+                HolographicFrameNativeData hfd = Marshal.PtrToStructure<HolographicFrameNativeData>(nativePtr);
+                return hfd.IHolographicFramePtr;
+            }
+        }
+    }
+}