Merge pull request #9674 from keveleigh/xrsdk-loaders

Ensure XR SDK providers only run on their specified loaders

Author: keveleigh

Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManager.cs

@@ -154,22 +154,13 @@ protected override SupportedControllerType GetCurrentControllerType(InputDevice
 
         #endregion Controller Utilities
 
-        private bool? isActiveLoader = null;
-        private bool IsActiveLoader
-        {
-            get
-            {
+        private bool IsActiveLoader =>
 #if OCULUS_ENABLED
-                if (!isActiveLoader.HasValue)
-                {
-                    isActiveLoader = IsLoaderActive<OculusLoader>();
-                }
+            LoaderHelpers.IsLoaderActive<OculusLoader>();
+#else
+            false;
 #endif // OCULUS_ENABLED
 
-                return isActiveLoader ?? false;
-            }
-        }
-
         /// <inheritdoc/>
         public override void Enable()
         {

Assets/MRTK/Providers/OpenXR/Scripts/OpenXRDeviceManager.cs

@@ -34,22 +34,13 @@ public OpenXRDeviceManager(
             uint priority = DefaultPriority,
             BaseMixedRealityProfile profile = null) : base(inputSystem, name, priority, profile) { }
 
-        private bool? isActiveLoader = null;
-        private bool IsActiveLoader
-        {
-            get
-            {
+        private bool IsActiveLoader =>
 #if UNITY_OPENXR
-                if (!isActiveLoader.HasValue)
-                {
-                    isActiveLoader = IsLoaderActive<OpenXRLoaderBase>();
-                }
+            LoaderHelpers.IsLoaderActive<OpenXRLoaderBase>();
+#else
+            false;
 #endif // UNITY_OPENXR
 
-                return isActiveLoader ?? false;
-            }
-        }
-
         /// <inheritdoc />
         public override void Enable()
         {

Assets/MRTK/Providers/OpenXR/Scripts/OpenXREyeGazeDataProvider.cs

@@ -10,6 +10,7 @@
 using UnityEngine.XR;
 
 #if UNITY_OPENXR
+using UnityEngine.XR.OpenXR;
 using UnityEngine.XR.OpenXR.Features.Interactions;
 #endif // UNITY_OPENXR
 
@@ -45,6 +46,13 @@ public OpenXREyeGazeDataProvider(
             gazeSmoother.OnSaccadeY += GazeSmoother_OnSaccadeY;
         }
 
+        private bool IsActiveLoader =>
+#if UNITY_OPENXR
+            LoaderHelpers.IsLoaderActive<OpenXRLoaderBase>();
+#else
+            false;
+#endif // UNITY_OPENXR
+
         /// <inheritdoc />
         public bool SmoothEyeTracking { get; set; } = false;
 
@@ -88,6 +96,18 @@ public override void Initialize()
             base.Initialize();
         }
 
+        /// <inheritdoc />
+        public override void Enable()
+        {
+            if (!IsActiveLoader)
+            {
+                IsEnabled = false;
+                return;
+            }
+
+            base.Enable();
+        }
+
         private void ReadProfile()
         {
             if (ConfigurationProfile == null)
@@ -117,6 +137,11 @@ public override void Update()
         {
             using (UpdatePerfMarker.Auto())
             {
+                if (!IsEnabled)
+                {
+                    return;
+                }
+
                 if (!eyeTrackingDevice.isValid)
                 {
                     InputDevices.GetDevicesWithCharacteristics(InputDeviceCharacteristics.EyeTracking, InputDeviceList);

Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityDeviceManager.cs

@@ -51,22 +51,13 @@ public WindowsMixedRealityDeviceManager(
             uint priority = DefaultPriority,
             BaseMixedRealityProfile profile = null) : base(inputSystem, name, priority, profile) { }
 
-        private bool? isActiveLoader = null;
-        private bool IsActiveLoader
-        {
-            get
-            {
+        private bool IsActiveLoader =>
 #if WMR_ENABLED
-                if (!isActiveLoader.HasValue)
-                {
-                    isActiveLoader = IsLoaderActive("Windows MR Loader");
-                }
+            LoaderHelpers.IsLoaderActive("Windows MR Loader");
+#else
+            false;
 #endif // WMR_ENABLED
 
-                return isActiveLoader ?? false;
-            }
-        }
-
         #region IMixedRealityDeviceManager Interface
 
         /// <inheritdoc />

Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityEyeGazeDataProvider.cs

@@ -46,6 +46,13 @@ public WindowsMixedRealityEyeGazeDataProvider(
             gazeSmoother.OnSaccadeY += GazeSmoother_OnSaccadeY;
         }
 
+        private bool IsActiveLoader =>
+#if WMR_ENABLED
+            LoaderHelpers.IsLoaderActive("Windows MR Loader");
+#else
+            false;
+#endif // WMR_ENABLED
+
         /// <inheritdoc />
         public bool SmoothEyeTracking { get; set; } = false;
 
@@ -68,6 +75,18 @@ public WindowsMixedRealityEyeGazeDataProvider(
         public event Action OnSaccadeY;
         private void GazeSmoother_OnSaccadeY() => OnSaccadeY?.Invoke();
 
+        /// <inheritdoc />
+        public override void Enable()
+        {
+            if (!IsActiveLoader)
+            {
+                IsEnabled = false;
+                return;
+            }
+
+            base.Enable();
+        }
+
         #region IMixedRealityCapabilityCheck Implementation
 
         /// <inheritdoc />
@@ -127,6 +146,11 @@ public override void Update()
         {
             using (UpdatePerfMarker.Auto())
             {
+                if (!IsEnabled)
+                {
+                    return;
+                }
+
                 if (!centerEye.isValid)
                 {
                     centerEye = InputDevices.GetDeviceAtXRNode(XRNode.CenterEye);

Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealitySpatialMeshObserver.cs

@@ -39,6 +39,13 @@ public WindowsMixedRealitySpatialMeshObserver(
             BaseMixedRealityProfile profile = null) : base(spatialAwarenessSystem, name, priority, profile)
         { }
 
+        protected override bool IsActiveLoader =>
+#if WMR_ENABLED
+            LoaderHelpers.IsLoaderActive("Windows MR Loader");
+#else
+            false;
+#endif // WMR_ENABLED
+
         private static readonly ProfilerMarker ConfigureObserverVolumePerfMarker = new ProfilerMarker("[MRTK] WindowsMixedRealitySpatialMeshObserver.ConfigureObserverVolume");
 
         private Vector3 oldObserverOrigin = Vector3.zero;

Assets/MRTK/Providers/XRSDK/GenericXRSDKSpatialMeshObserver.cs

@@ -41,6 +41,22 @@ public GenericXRSDKSpatialMeshObserver(
             BaseMixedRealityProfile profile = null) : base(spatialAwarenessSystem, name, priority, profile)
         { }
 
+        // Don't run this one on Windows MR, since that has its own observer
+        // There's probably a better way to manage these two...
+        protected virtual bool IsActiveLoader => !LoaderHelpers.IsLoaderActive("Windows MR Loader");
+
+        /// <inheritdoc />
+        public override void Enable()
+        {
+            if (!IsActiveLoader)
+            {
+                IsEnabled = false;
+                return;
+            }
+
+            base.Enable();
+        }
+
         #region BaseSpatialObserver Implementation
 
         private XRMeshSubsystem meshSubsystem;
@@ -133,6 +149,11 @@ public override void Update()
         {
             using (UpdatePerfMarker.Auto())
             {
+                if (!IsEnabled)
+                {
+                    return;
+                }
+
                 base.Update();
                 UpdateObserver();
             }

Assets/MRTK/Providers/XRSDK/LoaderHelpers.cs

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#if XR_MANAGEMENT_ENABLED
+using UnityEngine.XR.Management;
+#endif
+
+namespace Microsoft.MixedReality.Toolkit.XRSDK
+{
+    public static class LoaderHelpers
+    {
+        /// <summary>
+        /// Checks if the active loader has a specific name. Used in cases where the loader class is internal, like WindowsMRLoader.
+        /// </summary>
+        /// <param name="loaderName">The string name to compare against the active loader.</param>
+        /// <returns>True if the active loader has the same name as the parameter.</returns>
+        public static bool IsLoaderActive(string loaderName) =>
+#if XR_MANAGEMENT_ENABLED
+            XRGeneralSettings.Instance != null
+            && XRGeneralSettings.Instance.Manager != null
+            && XRGeneralSettings.Instance.Manager.activeLoader != null
+            && XRGeneralSettings.Instance.Manager.activeLoader.name == loaderName;
+#else
+            false;
+#endif
+
+#if XR_MANAGEMENT_ENABLED
+        /// <summary>
+        /// Checks if the active loader is of a specific type. Used in cases where the loader class is accessible, like OculusLoader.
+        /// </summary>
+        /// <typeparam name="T">The loader class type to check against the active loader.</typeparam>
+        /// <returns>True if the active loader is of the specified type.</returns>
+        public static bool IsLoaderActive<T>() where T : XRLoader =>
+            XRGeneralSettings.Instance != null
+            && XRGeneralSettings.Instance.Manager != null
+            && XRGeneralSettings.Instance.Manager.activeLoader is T;
+#endif
+    }
+}

Assets/MRTK/Providers/XRSDK/LoaderHelpers.cs.meta

@@ -63,15 +63,16 @@ public virtual bool CheckCapability(MixedRealityCapability capability)
         /// </summary>
         /// <param name="loaderName">The string name to compare against the active loader.</param>
         /// <returns>True if the active loader has the same name as the parameter.</returns>
-        protected virtual bool IsLoaderActive(string loaderName) => XRGeneralSettings.Instance != null && XRGeneralSettings.Instance.Manager != null &&
-            XRGeneralSettings.Instance.Manager.activeLoader != null && XRGeneralSettings.Instance.Manager.activeLoader.name == loaderName;
+        [Obsolete("Use XRSDKLoaderHelpers instead.")]
+        protected virtual bool IsLoaderActive(string loaderName) => LoaderHelpers.IsLoaderActive(loaderName);
 
         /// <summary>
         /// Checks if the active loader is of a specific type. Used in cases where the loader class is accessible, like OculusLoader.
         /// </summary>
         /// <typeparam name="T">The loader class type to check against the active loader.</typeparam>
         /// <returns>True if the active loader is of the specified type.</returns>
-        protected virtual bool IsLoaderActive<T>() where T : XRLoader => XRGeneralSettings.Instance != null && XRGeneralSettings.Instance.Manager != null && XRGeneralSettings.Instance.Manager.activeLoader is T;
+        [Obsolete("Use XRSDKLoaderHelpers instead.")]
+        protected virtual bool IsLoaderActive<T>() where T : XRLoader => LoaderHelpers.IsLoaderActive<T>();
 #endif // XR_MANAGEMENT_ENABLED
 
         private static readonly ProfilerMarker UpdatePerfMarker = new ProfilerMarker("[MRTK] XRSDKDeviceManager.Update");