Add ability to wait for a loader to become active

keveleigh · keveleigh · commit 86d70fd3271b · 2021-05-24T17:51:12.000-07:00
diff --git a/Assets/MRTK/Providers/Oculus/XRSDK/MRTK.Oculus.asmdef b/Assets/MRTK/Providers/Oculus/XRSDK/MRTK.Oculus.asmdef
@@ -1,6 +1,8 @@
 {
     "name": "Microsoft.MixedReality.Toolkit.Providers.XRSDK.Oculus",
+    "rootNamespace": "",
     "references": [
+        "Microsoft.MixedReality.Toolkit.Async",
         "Microsoft.MixedReality.Toolkit",
         "Microsoft.MixedReality.Toolkit.Services.InputSystem",
         "Microsoft.MixedReality.Toolkit.SDK",
diff --git a/Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManager.cs b/Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManager.cs
@@ -5,6 +5,7 @@
 using Microsoft.MixedReality.Toolkit.Utilities;
 using Microsoft.MixedReality.Toolkit.XRSDK.Input;
 using System;
+using UnityEngine;
 using UnityEngine.XR;
 
 #if OCULUS_ENABLED
@@ -154,7 +155,7 @@ protected override SupportedControllerType GetCurrentControllerType(InputDevice
 
         #endregion Controller Utilities
 
-        private bool IsActiveLoader =>
+        private bool? IsActiveLoader =>
 #if OCULUS_ENABLED
             LoaderHelpers.IsLoaderActive<OculusLoader>();
 #else
@@ -164,18 +165,33 @@ protected override SupportedControllerType GetCurrentControllerType(InputDevice
         /// <inheritdoc/>
         public override void Enable()
         {
-            if (!IsActiveLoader)
+            if (!IsActiveLoader.HasValue)
+            {
+                IsEnabled = false;
+                EnableIfLoaderBecomesActive();
+                return;
+            }
+            else if (!IsActiveLoader.Value)
             {
                 IsEnabled = false;
                 return;
             }
-
-            base.Enable();
 
 #if OCULUSINTEGRATION_PRESENT
             SetupInput();
             ConfigurePerformancePreferences();
 #endif // OCULUSINTEGRATION_PRESENT
+
+            base.Enable();
+        }
+
+        private async void EnableIfLoaderBecomesActive()
+        {
+            await new WaitUntil(() => IsActiveLoader.HasValue);
+            if (IsActiveLoader.Value)
+            {
+                Enable();
+            }
         }
 
 #if OCULUSINTEGRATION_PRESENT
diff --git a/Assets/MRTK/Providers/OpenXR/MRTK.OpenXR.asmdef b/Assets/MRTK/Providers/OpenXR/MRTK.OpenXR.asmdef
@@ -3,6 +3,7 @@
     "rootNamespace": "Microsoft.MixedReality.Toolkit.XRSDK.OpenXR",
     "references": [
         "Microsoft.MixedReality.OpenXR",
+        "Microsoft.MixedReality.Toolkit.Async",
         "Microsoft.MixedReality.Toolkit",
         "Microsoft.MixedReality.Toolkit.Gltf",
         "Microsoft.MixedReality.Toolkit.Providers.XRSDK",
diff --git a/Assets/MRTK/Providers/OpenXR/Scripts/OpenXRCameraSettings.cs b/Assets/MRTK/Providers/OpenXR/Scripts/OpenXRCameraSettings.cs
@@ -3,6 +3,7 @@
 
 using Microsoft.MixedReality.Toolkit.CameraSystem;
 using Microsoft.MixedReality.Toolkit.Utilities;
+using UnityEngine;
 
 #if UNITY_OPENXR
 using UnityEngine.XR.OpenXR;
@@ -36,7 +37,7 @@ public OpenXRCameraSettings(
             BaseCameraSettingsProfile profile = null) : base(cameraSystem, name, priority, profile)
         { }
 
-        private bool IsActiveLoader =>
+        private bool? IsActiveLoader =>
 #if UNITY_OPENXR
             LoaderHelpers.IsLoaderActive<OpenXRLoaderBase>();
 #else
@@ -50,14 +51,30 @@ public OpenXRCameraSettings(
         /// <inheritdoc />
         public override void Enable()
         {
-            if (!IsActiveLoader)
+            if (!IsActiveLoader.HasValue)
+            {
+                IsEnabled = false;
+                EnableIfLoaderBecomesActive();
+                return;
+            }
+            else if (!IsActiveLoader.Value)
             {
                 IsEnabled = false;
                 return;
             }
 
-            base.Enable();
             InitializeReprojectionUpdater();
+
+            base.Enable();
+        }
+
+        private async void EnableIfLoaderBecomesActive()
+        {
+            await new WaitUntil(() => IsActiveLoader.HasValue);
+            if (IsActiveLoader.Value)
+            {
+                Enable();
+            }
         }
 
         /// <inheritdoc/>
diff --git a/Assets/MRTK/Providers/OpenXR/Scripts/OpenXRDeviceManager.cs b/Assets/MRTK/Providers/OpenXR/Scripts/OpenXRDeviceManager.cs
@@ -6,6 +6,7 @@
 using Microsoft.MixedReality.Toolkit.XRSDK.Input;
 using System;
 using Unity.Profiling;
+using UnityEngine;
 using UnityEngine.XR;
 
 #if UNITY_OPENXR
@@ -39,7 +40,7 @@ public OpenXRDeviceManager(
             uint priority = DefaultPriority,
             BaseMixedRealityProfile profile = null) : base(inputSystem, name, priority, profile) { }
 
-        private bool IsActiveLoader =>
+        private bool? IsActiveLoader =>
 #if UNITY_OPENXR
             LoaderHelpers.IsLoaderActive<OpenXRLoaderBase>();
 #else
@@ -65,7 +66,13 @@ public OpenXRDeviceManager(
         /// <inheritdoc />
         public override void Enable()
         {
-            if (!IsActiveLoader)
+            if (!IsActiveLoader.HasValue)
+            {
+                IsEnabled = false;
+                EnableIfLoaderBecomesActive();
+                return;
+            }
+            else if (!IsActiveLoader.Value)
             {
                 IsEnabled = false;
                 return;
@@ -78,6 +85,15 @@ public override void Enable()
             base.Enable();
         }
 
+        private async void EnableIfLoaderBecomesActive()
+        {
+            await new WaitUntil(() => IsActiveLoader.HasValue);
+            if (IsActiveLoader.Value)
+            {
+                Enable();
+            }
+        }
+
 #if MSFT_OPENXR_0_9_4_OR_NEWER && WINDOWS_UWP
         /// <inheritdoc />
         public override void Initialize()
diff --git a/Assets/MRTK/Providers/OpenXR/Scripts/OpenXREyeGazeDataProvider.cs b/Assets/MRTK/Providers/OpenXR/Scripts/OpenXREyeGazeDataProvider.cs
@@ -46,7 +46,7 @@ public OpenXREyeGazeDataProvider(
             gazeSmoother.OnSaccadeY += GazeSmoother_OnSaccadeY;
         }
 
-        private bool IsActiveLoader =>
+        private bool? IsActiveLoader =>
 #if UNITY_OPENXR
             LoaderHelpers.IsLoaderActive<OpenXRLoaderBase>();
 #else
@@ -99,7 +99,13 @@ public override void Initialize()
         /// <inheritdoc />
         public override void Enable()
         {
-            if (!IsActiveLoader)
+            if (!IsActiveLoader.HasValue)
+            {
+                IsEnabled = false;
+                EnableIfLoaderBecomesActive();
+                return;
+            }
+            else if (!IsActiveLoader.Value)
             {
                 IsEnabled = false;
                 return;
@@ -108,6 +114,15 @@ public override void Enable()
             base.Enable();
         }
 
+        private async void EnableIfLoaderBecomesActive()
+        {
+            await new WaitUntil(() => IsActiveLoader.HasValue);
+            if (IsActiveLoader.Value)
+            {
+                Enable();
+            }
+        }
+
         private void ReadProfile()
         {
             if (ConfigurationProfile == null)
diff --git a/Assets/MRTK/Providers/OpenXR/Scripts/OpenXRSpatialAwarenessMeshObserver.cs b/Assets/MRTK/Providers/OpenXR/Scripts/OpenXRSpatialAwarenessMeshObserver.cs
@@ -39,7 +39,7 @@ public OpenXRSpatialAwarenessMeshObserver(
             BaseMixedRealityProfile profile = null) : base(spatialAwarenessSystem, name, priority, profile)
         { }
 
-        protected override bool IsActiveLoader =>
+        protected override bool? IsActiveLoader =>
 #if MSFT_OPENXR_0_9_4_OR_NEWER
             LoaderHelpers.IsLoaderActive<OpenXRLoaderBase>();
 #else
diff --git a/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/MRTK.WMR.XRSDK.asmdef b/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/MRTK.WMR.XRSDK.asmdef
@@ -1,6 +1,7 @@
 {
     "name": "Microsoft.MixedReality.Toolkit.Providers.XRSDK.WindowsMixedReality",
     "references": [
+        "Microsoft.MixedReality.Toolkit.Async",
         "Microsoft.MixedReality.Toolkit",
         "Microsoft.MixedReality.Toolkit.Editor.Utilities",
         "Microsoft.MixedReality.Toolkit.Providers.WindowsMixedReality.Shared",
diff --git a/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityCameraSettings.cs b/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityCameraSettings.cs
@@ -4,6 +4,7 @@
 using Microsoft.MixedReality.Toolkit.CameraSystem;
 using Microsoft.MixedReality.Toolkit.Utilities;
 using Microsoft.MixedReality.Toolkit.WindowsMixedReality;
+using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality
 {
@@ -33,7 +34,7 @@ public WindowsMixedRealityCameraSettings(
             BaseCameraSettingsProfile profile = null) : base(cameraSystem, name, priority, profile)
         { }
 
-        private bool IsActiveLoader =>
+        private bool? IsActiveLoader =>
 #if WMR_ENABLED
             LoaderHelpers.IsLoaderActive("Windows MR Loader");
 #else
@@ -43,7 +44,13 @@ public WindowsMixedRealityCameraSettings(
         /// <inheritdoc />
         public override void Enable()
         {
-            if (!IsActiveLoader)
+            if (!IsActiveLoader.HasValue)
+            {
+                IsEnabled = false;
+                EnableIfLoaderBecomesActive();
+                return;
+            }
+            else if (!IsActiveLoader.Value)
             {
                 IsEnabled = false;
                 return;
@@ -52,6 +59,15 @@ public override void Enable()
             base.Enable();
         }
 
+        private async void EnableIfLoaderBecomesActive()
+        {
+            await new WaitUntil(() => IsActiveLoader.HasValue);
+            if (IsActiveLoader.Value)
+            {
+                Enable();
+            }
+        }
+
         #region IMixedRealityCameraSettings
 
         /// <inheritdoc/>
diff --git a/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityDeviceManager.cs b/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityDeviceManager.cs
@@ -7,6 +7,7 @@
 using Microsoft.MixedReality.Toolkit.WindowsMixedReality;
 using Microsoft.MixedReality.Toolkit.XRSDK.Input;
 using System;
+using UnityEngine;
 using UnityEngine.XR;
 
 #if HP_CONTROLLER_ENABLED
@@ -51,7 +52,7 @@ public WindowsMixedRealityDeviceManager(
             uint priority = DefaultPriority,
             BaseMixedRealityProfile profile = null) : base(inputSystem, name, priority, profile) { }
 
-        private bool IsActiveLoader =>
+        private bool? IsActiveLoader =>
 #if WMR_ENABLED
             LoaderHelpers.IsLoaderActive("Windows MR Loader");
 #else
@@ -63,13 +64,17 @@ public WindowsMixedRealityDeviceManager(
         /// <inheritdoc />
         public override void Enable()
         {
-            if (!IsActiveLoader)
+            if (!IsActiveLoader.HasValue)
+            {
+                IsEnabled = false;
+                EnableIfLoaderBecomesActive();
+                return;
+            }
+            else if (!IsActiveLoader.Value)
             {
                 IsEnabled = false;
                 return;
             }
-
-            base.Enable();
 
             if (WindowsMixedRealityUtilities.UtilitiesProvider == null)
             {
@@ -87,6 +92,17 @@ public override void Enable()
             motionControllerWatcher.MotionControllerRemoved += RemoveTrackedMotionController;
             var nowait = motionControllerWatcher.StartAsync();
 #endif // HP_CONTROLLER_ENABLED
+
+            base.Enable();
+        }
+
+        private async void EnableIfLoaderBecomesActive()
+        {
+            await new WaitUntil(() => IsActiveLoader.HasValue);
+            if (IsActiveLoader.Value)
+            {
+                Enable();
+            }
         }
 
 #if (UNITY_WSA && DOTNETWINRT_PRESENT) || WINDOWS_UWP
diff --git a/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityEyeGazeDataProvider.cs b/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityEyeGazeDataProvider.cs
@@ -4,13 +4,13 @@
 using Microsoft.MixedReality.Toolkit.Input;
 using Microsoft.MixedReality.Toolkit.Utilities;
 using System;
+using UnityEngine;
 
 // These versions represent the first version eye tracking became usable across Unity 2019/2020/2021
 // WMR_2_7_0_OR_NEWER stops being defined at 3.0 and WMR_4_4_2_OR_NEWER stops being defined at 5.0, exclusive
 #if WMR_2_7_0_OR_NEWER || WMR_4_4_2_OR_NEWER || WMR_5_2_2_OR_NEWER
 using Unity.Profiling;
 using Unity.XR.WindowsMR;
-using UnityEngine;
 using UnityEngine.XR;
 #endif // WMR_2_7_0_OR_NEWER || WMR_4_4_2_OR_NEWER || WMR_5_2_2_OR_NEWER
 
@@ -46,7 +46,7 @@ public WindowsMixedRealityEyeGazeDataProvider(
             gazeSmoother.OnSaccadeY += GazeSmoother_OnSaccadeY;
         }
 
-        private bool IsActiveLoader =>
+        private bool? IsActiveLoader =>
 #if WMR_ENABLED
             LoaderHelpers.IsLoaderActive("Windows MR Loader");
 #else
@@ -78,7 +78,13 @@ public WindowsMixedRealityEyeGazeDataProvider(
         /// <inheritdoc />
         public override void Enable()
         {
-            if (!IsActiveLoader)
+            if (!IsActiveLoader.HasValue)
+            {
+                IsEnabled = false;
+                EnableIfLoaderBecomesActive();
+                return;
+            }
+            else if (!IsActiveLoader.Value)
             {
                 IsEnabled = false;
                 return;
@@ -87,6 +93,15 @@ public override void Enable()
             base.Enable();
         }
 
+        private async void EnableIfLoaderBecomesActive()
+        {
+            await new WaitUntil(() => IsActiveLoader.HasValue);
+            if (IsActiveLoader.Value)
+            {
+                Enable();
+            }
+        }
+
         #region IMixedRealityCapabilityCheck Implementation
 
         /// <inheritdoc />
diff --git a/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealitySpatialMeshObserver.cs b/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealitySpatialMeshObserver.cs
@@ -38,7 +38,7 @@ public WindowsMixedRealitySpatialMeshObserver(
             BaseMixedRealityProfile profile = null) : base(spatialAwarenessSystem, name, priority, profile)
         { }
 
-        protected override bool IsActiveLoader =>
+        protected override bool? IsActiveLoader =>
 #if WMR_ENABLED
             LoaderHelpers.IsLoaderActive("Windows MR Loader");
 #else
diff --git a/Assets/MRTK/Providers/XRSDK/GenericXRSDKSpatialMeshObserver.cs b/Assets/MRTK/Providers/XRSDK/GenericXRSDKSpatialMeshObserver.cs
diff --git a/Assets/MRTK/Providers/XRSDK/MRTK.XRSDK.asmdef b/Assets/MRTK/Providers/XRSDK/MRTK.XRSDK.asmdef
diff --git a/Assets/MRTK/Providers/XRSDK/XRSDKDeviceManager.cs b/Assets/MRTK/Providers/XRSDK/XRSDKDeviceManager.cs

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Microsoft.MixedReality.Toolkit.Providers.XRSDK.Oculus",`
	`3`	`+ "rootNamespace": "",`
`3`	`4`	`"references": [`
	`5`	`+ "Microsoft.MixedReality.Toolkit.Async",`
`4`	`6`	`"Microsoft.MixedReality.Toolkit",`
`5`	`7`	`"Microsoft.MixedReality.Toolkit.Services.InputSystem",`
`6`	`8`	`"Microsoft.MixedReality.Toolkit.SDK",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Microsoft.MixedReality.Toolkit.Providers.XRSDK.WindowsMixedReality",`
`3`	`3`	`"references": [`
	`4`	`+ "Microsoft.MixedReality.Toolkit.Async",`
`4`	`5`	`"Microsoft.MixedReality.Toolkit",`
`5`	`6`	`"Microsoft.MixedReality.Toolkit.Editor.Utilities",`
`6`	`7`	`"Microsoft.MixedReality.Toolkit.Providers.WindowsMixedReality.Shared",`