Check active XRSDK providers

Author: MaxWang-MS

Assets/MRTK/Core/Inspectors/MRTK.Inspectors.asmdef

@@ -7,7 +7,9 @@
         "Microsoft.MixedReality.Toolkit.Editor.ClassExtensions",
         "Microsoft.MixedReality.Toolkit.Editor.Utilities",
         "Unity.TextMeshPro.Editor",
-        "Unity.TextMeshPro"
+        "Unity.TextMeshPro",
+        "Unity.XR.Management",
+        "Unity.XR.Management.Editor"
     ],
     "optionalUnityReferences": [],
     "includePlatforms": [
@@ -18,5 +20,13 @@
     "overrideReferences": false,
     "precompiledReferences": [],
     "autoReferenced": true,
-    "defineConstraints": []
+    "defineConstraints": [],
+    "versionDefines": [
+        {
+            "name": "com.microsoft.mixedreality.openxr",
+            "expression": "",
+            "define": "MSFT_OPENXR"
+        }
+    ],
+    "noEngineReferences": false
 }

Assets/MRTK/Core/Inspectors/Setup/XRPipelineConfigWindow.cs

@@ -5,6 +5,7 @@
 using System.Linq;
 using TMPro;
 using UnityEditor;
+using UnityEditor.Compilation;
 using UnityEditor.PackageManager;
 using UnityEngine;
 
@@ -33,6 +34,17 @@ private static ConfigurationStage currentStage
     private void OnEnable()
     {
         Instance = this;
+
+        CompilationPipeline.compilationStarted += CompilationPipeline_compilationStarted;
+        MixedRealityProjectConfigurator.SelectedSpatializer = SpatializerUtilities.CurrentSpatializer;
+    }
+
+    private void CompilationPipeline_compilationStarted(object obj)
+    {
+        // There should be only one pop-up window which is generally tracked by IsOpen
+        // However, when recompiling, Unity will call OnDestroy for this window but not actually destroy the editor window
+        // This ensure we have a clean close on recompiles when this EditorWindow was open beforehand
+        //Close();
     }
 
     [MenuItem("Ut/Configure Demo", false, 499)]
@@ -55,10 +67,14 @@ public static void ShowWindow()
     private void OnGUI()
     {
         MixedRealityInspectorUtility.RenderMixedRealityToolkitLogo();
-        EditorGUILayout.LabelField("Welcome to MRTK!", MixedRealityStylesUtility.BoldLargeTitleStyle);
-        EditorGUILayout.Space(5);
-        EditorGUILayout.LabelField("This configurator will go through some settings to make sure the project is ready for MRTK.");
-        EditorGUILayout.Space(20);
+        if (currentStage != ConfigurationStage.Done)
+        {
+            EditorGUILayout.LabelField("Welcome to MRTK!", MixedRealityStylesUtility.BoldLargeTitleStyle);
+            EditorGUILayout.Space(5);
+            EditorGUILayout.LabelField("This configurator will go through some settings to make sure the project is ready for MRTK.");
+            EditorGUILayout.Space(20);
+        }
+        
 
         switch (currentStage)
         {
@@ -78,19 +94,9 @@ private void OnGUI()
                 RenderProjectConfigurations();
                 break;
             case ConfigurationStage.ImportTMP:
-                if (TMPEssentialsImported())
-                {
-                    currentStage = ConfigurationStage.ShowExamples;
-                    Repaint();
-                }
                 RenderImportTMP();
                 break;
             case ConfigurationStage.ShowExamples:
-                if (!MRTKExamplesPackageImportedViaUPM())
-                {
-                    currentStage = ConfigurationStage.Done;
-                    Repaint();
-                }
                 RenderShowUPMExamples();
                 break;
             case ConfigurationStage.Done:
@@ -143,7 +149,11 @@ private void RenderNoPipeline()
 #if UNITY_2019_3_OR_NEWER
             if (GUILayout.Button("XR SDK/XR Management (Recommended)"))
             {
+#if UNITY_2020_2_OR_NEWER
                 currentStage = ConfigurationStage.SelectXRSDKPlugin;
+#else
+                currentStage = ConfigurationStage.InstallBuiltinPlugin;
+#endif
                 Repaint();
             }
 #endif
@@ -227,6 +237,11 @@ private void RenderXRSDKBuiltinPluginPipelineDetected()
 
     private void RenderSelectXRSDKPlugin()
     {
+        if (XRSettingsUtilities.XRSDKEnabled)
+        {
+            currentStage = ConfigurationStage.Init;
+            Repaint();
+        }
         EditorGUILayout.LabelField("Enabling the XR SDK Pipeline", EditorStyles.boldLabel);
         //EditorGUILayout.Space();
         EditorGUILayout.LabelField("There are several provider plugins for the XR SDK pipeline available in this Unity version. "
@@ -278,8 +293,15 @@ private void RenderEnableXRSDKBuiltinPlugin()
         {
             if (GUILayout.Button("Show Settings"))
             {
-                //SettingsService.OpenProjectSettings("Project/XR Plug-in Management");
-                SettingsService.OpenProjectSettings("Project/XR Plugin Management");
+
+                if (XRSettingsUtilities.XRManagementPresent)
+                {
+                    SettingsService.OpenProjectSettings("Project/XR Plug-in Management");
+                }
+                else
+                {
+                    SettingsService.OpenProjectSettings("Project/XR Plugin Management");
+                }
             }
             if (GUILayout.Button("Learn more"))
             {
@@ -294,6 +316,11 @@ private void RenderEnableXRSDKBuiltinPlugin()
 
     private void RenderEnableMicrosoftOpenXRPlugin()
     {
+        if (XRSettingsUtilities.MicrosoftOpenXREnabled)
+        {
+            currentStage = ConfigurationStage.Init;
+            Repaint();
+        }
         EditorGUILayout.LabelField("Enabling the XR SDK Pipeline with OpenXR", EditorStyles.boldLabel);
         //EditorGUILayout.Space();
         EditorGUILayout.LabelField("To use OpenXR with the XR SDK pipeline, first press the Download Tool button. "
@@ -368,6 +395,11 @@ private void RenderChoiceDialog(MixedRealityProjectConfiguratorWindow window)
 
     private void RenderImportTMP()
     {
+        if (TMPEssentialsImported())
+        {
+            currentStage = ConfigurationStage.ShowExamples;
+            Repaint();
+        }
         EditorGUILayout.LabelField("Importing TMP Essentials", EditorStyles.boldLabel);
         //EditorGUILayout.Space();
         EditorGUILayout.LabelField("MRTK contains components that depend on TextMeshPro. It is recommended that you import TMP by clicking the Import TMP Essentials button below. "
@@ -387,6 +419,11 @@ private void RenderImportTMP()
 
     private void RenderShowUPMExamples()
     {
+        if (!MRTKExamplesPackageImportedViaUPM())
+        {
+            currentStage = ConfigurationStage.Done;
+            Repaint();
+        }
         EditorGUILayout.LabelField("Locating MRTK Examples", EditorStyles.boldLabel);
         //EditorGUILayout.Space();
         EditorGUILayout.LabelField("The MRTK Examples package includes samples to help you familiarize yourself with many core features. "
@@ -413,6 +450,15 @@ private void RenderShowUPMExamples()
 
     private void RenderConfigurationCompleted()
     {
+        EditorGUILayout.LabelField("MRTK Setup Completed!", MixedRealityStylesUtility.BoldLargeTitleStyle);
+        EditorGUILayout.Space(5);
+        EditorGUILayout.LabelField("You have finished setting up the project for Mixed Reality Toolkit. You may go through this process again by clicking Mixed Reality Toolkit on the editor menu bar -> Ultilities -> Config."
+            + $"\nIf there are certain settings not set according to the recommendation you may see this configurator popping up again. You may use the Ignore or Later button to suppress the behavior. "
+            + "We hope you enjoy using MRTK. Please find the links to our documentation and API references below. If you encountered something looking like a bug please report by opening an issue in our repository. "
+            + "\nThese links are accessible through Mixed Reality Toolkit on the editor menu bar -> Help "
+            + $"After finishing the process in the feature tool come back here to verify whether the installation is successful. A new page should be shown if you succeeded."
+            + $"\n\nMore information can be found at {MRFTDocsUrl}.", EditorStyles.wordWrappedLabel);
+        EditorGUILayout.Space(20);
         EditorGUILayout.LabelField("Enabling the XR SDK Pipeline with OpenXR", EditorStyles.boldLabel);
         //EditorGUILayout.Space();
         EditorGUILayout.LabelField("To use OpenXR with the XR SDK pipeline, first press the Download Tool button. "

Assets/MRTK/Core/Utilities/Editor/MRTK.Editor.Utilities.asmdef

@@ -3,7 +3,9 @@
     "references": [
         "Unity.TextMeshPro.Editor",
         "Unity.TextMeshPro",
-        "Microsoft.MixedReality.Toolkit.Editor.ClassExtensions"
+        "Microsoft.MixedReality.Toolkit.Editor.ClassExtensions",
+        "Unity.XR.Management",
+        "Unity.XR.Management.Editor"
     ],
     "optionalUnityReferences": [],
     "includePlatforms": [
@@ -14,5 +16,18 @@
     "overrideReferences": false,
     "precompiledReferences": [],
     "autoReferenced": true,
-    "defineConstraints": []
+    "defineConstraints": [],
+    "versionDefines": [
+        {
+            "name": "com.microsoft.mixedreality.openxr",
+            "expression": "",
+            "define": "MSFT_OPENXR"
+        },
+        {
+            "name": "com.unity.xr.management",
+            "expression": "",
+            "define": "XR_MANAGEMENT_ENABLED"
+        }
+    ],
+    "noEngineReferences": false
 }

Assets/MRTK/Core/Utilities/Editor/XRSettingsUtilities.cs

@@ -7,6 +7,11 @@
 using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.XR;
+using System.Linq;
+#if XR_MANAGEMENT_ENABLED
+using UnityEngine.XR.Management;
+using UnityEditor.XR.Management;
+#endif // XR_MANAGEMENT_ENABLED
 #endif // UNITY_2019_3_OR_NEWER
 
 namespace Microsoft.MixedReality.Toolkit.Utilities.Editor
@@ -47,8 +52,36 @@ public static bool XRSDKEnabled
         {
             get
             {
-#if UNITY_2019_3_OR_NEWER
-                return IsXRSDKSuppressingLegacyXR;
+#if UNITY_2019_3_OR_NEWER && XR_MANAGEMENT_ENABLED
+                if (MicrosoftOpenXREnabled)
+                {
+                    return true;
+                }
+                else if (XRSDKLoadersOfCurrentBuildTarget.Count == 1 && XRSDKLoadersOfCurrentBuildTarget[0].name.Contains("Open XR"))
+                {
+                    return false;
+                }
+                else
+                {
+                    return XRSDKLoadersOfCurrentBuildTarget.Count > 0;
+                }
+#else
+                return false;
+#endif // UNITY_2019_3_OR_NEWER && XR_MANAGEMENT_ENABLED
+            }
+        }
+
+
+        /// <summary>
+        /// Gets or sets the legacy virtual reality supported property in the player settings.
+        /// </summary>
+        /// <remarks>Returns true if legacy XR is disabled due to XR SDK in Unity 2019.3+.</remarks>
+        public static bool MicrosoftOpenXRPresent
+        {
+            get
+            {
+#if UNITY_2020_2_OR_NEWER && MSFT_OPENXR
+                return true;
 #else
                 return false;
 #endif // UNITY_2019_3_OR_NEWER
@@ -64,8 +97,8 @@ public static bool MicrosoftOpenXREnabled
         {
             get
             {
-#if UNITY_2019_3_OR_NEWER
-                return IsXRSDKSuppressingLegacyXR;
+#if UNITY_2020_2_OR_NEWER && MSFT_OPENXR
+                return XRSDKLoadersOfCurrentBuildTarget.Any(p => p.name.Contains("Open XR"));
 #else
                 return false;
 #endif // UNITY_2019_3_OR_NEWER
@@ -88,18 +121,18 @@ public static bool LegacyXREnabled
 #endif // UNITY_2020_2_OR_NEWER
             }
 
-#if !UNITY_2020_2_OR_NEWER
             set
             {
-                // Ensure compatibility with the pre-2019.3 XR architecture for customers / platforms
-                // with legacy requirements.
+#if UNITY_2020_2_OR_NEWER
+                Debug.LogWarning("This set operation has not effect as Legacy XR has been removed in Unity 2020!");
+#else
 #pragma warning disable 0618
                 PlayerSettings.virtualRealitySupported = value;
 #pragma warning restore 0618
-            }
 #endif // !UNITY_2020_2_OR_NEWER
+            }
         }
-        
+
         /// <summary>
         /// Checks if an XR SDK plug-in is installed that disables legacy VR. Returns false if so.
         /// </summary>
@@ -117,6 +150,22 @@ public static bool IsLegacyXRAvailable
             }
         }
 
+        /// <summary>
+        /// Gets or sets the legacy virtual reality supported property in the player settings.
+        /// </summary>
+        /// <remarks>Returns true if legacy XR is disabled due to XR SDK in Unity 2019.3+.</remarks>
+        public static bool XRManagementPresent
+        {
+            get
+            {
+#if XR_MANAGEMENT_ENABLED
+                return true;
+#else
+                return false;
+#endif // XR_MANAGEMENT_ENABLED
+            }
+        }
+
 #if UNITY_2019_3_OR_NEWER
         private static bool? isXRSDKSuppressingLegacyXR = null;
 
@@ -155,9 +204,25 @@ private static bool IsXRSDKSuppressingLegacyXR
         /// Called when packages are installed or uninstalled, to toggle a new check on XR SDK package installation status.
         /// </summary>
         private static void EditorApplication_projectChanged() => isXRSDKSuppressingLegacyXR = null;
+#if XR_MANAGEMENT_ENABLED
+        /// <summary>
+        /// Is either LegacyXR pipeline or XRSDK pipeline enabled?
+        /// </summary>
+        private static IReadOnlyList<XRLoader> XRSDKLoadersOfCurrentBuildTarget
+        {
+            get
+            {
+                BuildTargetGroup currentBuildTarget = BuildPipeline.GetBuildTargetGroup(EditorUserBuildSettings.activeBuildTarget);
+                XRGeneralSettings settingsOfCurrentTarget = XRGeneralSettingsPerBuildTarget.XRGeneralSettingsForBuildTarget(currentBuildTarget);
+#pragma warning disable CS0618 // Suppressing the warning to support xr management plugin 3.x and 4.x
+                return settingsOfCurrentTarget.AssignedSettings.loaders;
+#pragma warning restore CS0618
+            }
+        }
+#endif // XR_MANAGEMENT_ENABLED
 #endif // UNITY_2019_3_OR_NEWER
-        
-        [System.Obsolete("Call GetDefaultMappings(Handedness) instead.")]
+
+        [System.Obsolete("Call IsLegacyXRAvailable instead.")]
         public static bool IsLegacyXRActive => IsLegacyXRAvailable;
     }
 }

Assets/MRTK/Tools/OptimizeWindow/MixedRealityOptimizeWindow.cs

@@ -146,7 +146,7 @@ private void OnGUI()
             EditorGUILayout.HelpBox(PerformanceTargetDescriptions[(int)PerfTarget], MessageType.Info);
             EditorGUILayout.Space();
 
-            if (!XRSettingsUtilities.LegacyXREnabled)
+            if (!XRSettingsUtilities.LegacyXREnabled && XRSettingsUtilities.IsLegacyXRAvailable)
             {
                 EditorGUILayout.HelpBox("Virtual reality support is not enabled in player settings", MessageType.Error);
                 if (GUILayout.Button("Enable Virtual Reality Support"))