Merge pull request #9714 from keveleigh/scene-content-alignment

Update scene content alignment and boundary system

Author: keveleigh

Assets/MRTK/Core/Definitions/MixedRealityToolkitConfigurationProfile.cs

@@ -152,7 +152,7 @@ public SystemType InputSystemType
         /// </summary>
         public bool IsBoundarySystemEnabled
         {
-            get { return boundarySystemType != null && boundarySystemType.Type != null && enableBoundarySystem && boundaryVisualizationProfile != null; }
+            get { return BoundarySystemSystemType != null && BoundarySystemSystemType.Type != null && enableBoundarySystem && boundaryVisualizationProfile != null; }
             internal set { enableBoundarySystem = value; }
         }
 

Assets/MRTK/Core/Services/BaseBoundarySystem.cs

@@ -47,6 +47,7 @@ private void ReadProfile()
         /// <summary>
         /// Whether any XR device is present.
         /// </summary>
+        [System.Obsolete("This value is no longer used.")]
         protected virtual bool IsXRDevicePresent { get; } = true;
 
         #region IMixedRealityService Implementation
@@ -58,30 +59,41 @@ private void ReadProfile()
         /// <inheritdoc/>
         public override string Name { get; protected set; } = "Mixed Reality Boundary System";
 
-        private bool boundarySystemInitialized = false;
-
         /// <inheritdoc/>
         public override void Initialize()
         {
-            base.Initialize();
+            // Initialize this value earlier than other systems, so we can use it to block boundary events being raised too early
+            IsInitialized = false;
 
             // The profile needs to be read on initialization to ensure that re-initialization
             // after profile change reads the correct data.
             ReadProfile();
 
-            if (!Application.isPlaying || !IsXRDevicePresent) { return; }
+            if (!Application.isPlaying || !DeviceUtility.IsPresent) { return; }
 
             boundaryEventData = new BoundaryEventData(EventSystem.current);
 
             SetTrackingSpace();
             CalculateBoundaryBounds();
 
-            boundarySystemInitialized = true;
+            base.Initialize();
 
             RefreshVisualization();
             RaiseBoundaryVisualizationChanged();
         }
 
+#if UNITY_EDITOR
+        public override void Update()
+        {
+            base.Update();
+
+            // If a device is attached late, initialize with the new state of the world
+            if (!IsInitialized && DeviceUtility.IsPresent)
+            {
+                Initialize();
+            }
+        }
+#endif // UNITY_EDITOR
 
         /// <inheritdoc/>
         public override void Destroy()
@@ -526,7 +538,7 @@ private void PropertyAction(bool value, GameObject boundaryObject, System.Action
         {
             // If not done initializing, no need to raise the changed event or check the visualization.
             // These will both happen at the end of the initialization flow.
-            if (!boundarySystemInitialized)
+            if (!IsInitialized)
             {
                 return;
             }

Assets/MRTK/Core/Services/MixedRealityToolkit.cs

@@ -470,7 +470,7 @@ private void InitializeServiceLocator()
             }
 
             // If the Boundary system has been selected for initialization in the Active profile, enable it in the project
-            if (ActiveProfile.IsBoundarySystemEnabled && !ActiveProfile.ExperienceSettingsProfile.IsNull())
+            if (ActiveProfile.IsBoundarySystemEnabled && ActiveProfile.ExperienceSettingsProfile != null)
             {
                 DebugUtilities.LogVerbose("Begin registration of the boundary system");
                 object[] args = { ActiveProfile.BoundaryVisualizationProfile, ActiveProfile.ExperienceSettingsProfile.TargetExperienceScale };

Assets/MRTK/Core/Utilities/SceneContent/MixedRealitySceneContent.cs

@@ -19,21 +19,24 @@ namespace Microsoft.MixedReality.Toolkit
     /// </summary>
     public class MixedRealitySceneContent : MonoBehaviour
     {
-        public enum AlignmentType
+        private enum AlignmentType
         {
             AlignWithExperienceScale,
             AlignWithHeadHeight
         }
 
         [SerializeField]
         [Tooltip("Select this if the container should be placed in front of the head on app launch in a room scale app.")]
-        public AlignmentType alignmentType = AlignmentType.AlignWithExperienceScale;
-
-        private Vector3 contentPosition = Vector3.zero;
+        private AlignmentType alignmentType = AlignmentType.AlignWithExperienceScale;
 
+        [SerializeField]
         [Tooltip("Optional container object reference. If null, this script will move the object it's attached to.")]
         private Transform containerObject = null;
 
+        private Vector3 contentPosition = Vector3.zero;
+        private const uint MaxEditorFrameWaitCount = 5;
+        private Coroutine initializeSceneContentWithDelay;
+
         private void Awake()
         {
             if (containerObject == null)
@@ -42,14 +45,36 @@ private void Awake()
             }
 
             // Init the content height on non-XR platforms
-            StartCoroutine(InitializeSceneContentWithDelay());
+            initializeSceneContentWithDelay = StartCoroutine(InitializeSceneContentWithDelay());
+        }
+
+        private void OnDestroy()
+        {
+            if (initializeSceneContentWithDelay != null)
+            {
+                StopCoroutine(initializeSceneContentWithDelay);
+            }
         }
 
-        // Not waiting a frame often caused the camera's position to be incorrect at this point. This seems like a Unity bug.
+        // Not waiting often caused the camera's position to be incorrect at this point. This seems like a Unity bug.
+        // Editor takes a little longer to init.
         private IEnumerator InitializeSceneContentWithDelay()
         {
-            yield return null;
+            if (Application.isEditor)
+            {
+                for (int i = 0; i < MaxEditorFrameWaitCount; i++)
+                {
+                    yield return null;
+                }
+            }
+            else
+            {
+                yield return null;
+            }
+
             InitializeSceneContent();
+
+            initializeSceneContentWithDelay = null;
         }
 
 
@@ -77,8 +102,8 @@ public void InitializeSceneContent()
 #if UNITY_2020_1_OR_NEWER
                     XRSubsystemHelpers.InputSubsystem != null && XRSubsystemHelpers.InputSubsystem.GetTrackingOriginMode().HasFlag(TrackingOriginModeFlags.Floor);
 #elif UNITY_2019_1_OR_NEWER
-#pragma warning disable 0618
                     (XRSubsystemHelpers.InputSubsystem != null && XRSubsystemHelpers.InputSubsystem.GetTrackingOriginMode().HasFlag(TrackingOriginModeFlags.Floor)) ||
+#pragma warning disable 0618
                     (XRDevice.isPresent && XRDevice.GetTrackingSpaceType() == TrackingSpaceType.RoomScale);
 #pragma warning restore 0618
 #else
@@ -97,11 +122,6 @@ public void InitializeSceneContent()
 
                     containerObject.position = contentPosition;
                 }
-                else
-                {
-                    contentPosition = Vector3.zero;
-                    containerObject.position = contentPosition;
-                }
             }
 
             if (alignmentType == AlignmentType.AlignWithHeadHeight)

Assets/MRTK/Core/Utilities/XRSettingsUtilities.cs

@@ -15,9 +15,9 @@ namespace Microsoft.MixedReality.Toolkit.Utilities
     /// </summary>
     public static class XRSettingsUtilities
     {
-#if UNITY_2019_3_OR_NEWER
+#if UNITY_2019_3_OR_NEWER && !UNITY_2020_2_OR_NEWER
         private static bool? legacyXRAvailable = null;
-#endif // UNITY_2019_3_OR_NEWER
+#endif // UNITY_2019_3_OR_NEWER && !UNITY_2020_2_OR_NEWER
 
         /// <summary>
         /// Checks if an XR SDK plug-in is installed that disables legacy VR. Returns false if so.
@@ -26,7 +26,9 @@ public static bool LegacyXRAvailable
         {
             get
             {
-#if UNITY_2019_3_OR_NEWER
+#if UNITY_2020_2_OR_NEWER
+                return false;
+#elif UNITY_2019_3_OR_NEWER
                 if (!legacyXRAvailable.HasValue)
                 {
                     legacyXRAvailable = true;
@@ -47,7 +49,7 @@ public static bool LegacyXRAvailable
                 return legacyXRAvailable.HasValue && legacyXRAvailable.Value;
 #else
                 return true;
-#endif // UNITY_2019_3_OR_NEWER
+#endif // UNITY_2020_2_OR_NEWER
             }
         }
     }

Assets/MRTK/Examples/Demos/HandTracking/Scenes/HandInteractionExamples.unity

@@ -25520,7 +25520,8 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: c65c9dd2f312b8d41b8849d58e1053fa, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
-  alignmentType: 0
+  alignmentType: 1
+  containerObject: {fileID: 0}
 --- !u!114 &1700502666 stripped
 MonoBehaviour:
   m_CorrespondingSourceObject: {fileID: 4448574576992466704, guid: ffbe4bef620a0a542bb77fe2f765c905,

Assets/MRTK/Providers/XRSDK/XRSDKBoundarySystem.cs

@@ -30,17 +30,6 @@ public XRSDKBoundarySystem(
         private static readonly List<XRInputSubsystem> XRInputSubsystems = new List<XRInputSubsystem>();
 #endif // UNITY_2019_3_OR_NEWER
 
-        /// <inheritdoc/>
-        protected override bool IsXRDevicePresent
-        {
-            get
-            {
-                List<InputDevice> devices = new List<InputDevice>();
-                InputDevices.GetDevicesWithCharacteristics(InputDeviceCharacteristics.HeadMounted, devices);
-                return devices.Count > 0;
-            }
-        }
-
         #region IMixedRealityService Implementation
 
         /// <inheritdoc/>
@@ -51,31 +40,27 @@ protected override bool IsXRDevicePresent
         /// <inheritdoc/>
         protected override List<Vector3> GetBoundaryGeometry()
         {
-            // Boundaries are supported for Room Scale experiences only.
-            if (XRSubsystemHelpers.InputSubsystem?.GetTrackingOriginMode() != TrackingOriginModeFlags.Floor)
-            {
-                return null;
-            }
-
             // Get the boundary geometry.
             var boundaryGeometry = new List<Vector3>(0);
 
-            if (!XRSubsystemHelpers.InputSubsystem.TryGetBoundaryPoints(boundaryGeometry) || boundaryGeometry.Count == 0)
+            if (XRSubsystemHelpers.InputSubsystem?.GetTrackingOriginMode() != TrackingOriginModeFlags.Floor
+                || !XRSubsystemHelpers.InputSubsystem.TryGetBoundaryPoints(boundaryGeometry)
+                || boundaryGeometry.Count == 0)
             {
 #if UNITY_2019_3_OR_NEWER
                 // If the "main" input subsystem doesn't have an available boundary, check the rest of them
                 SubsystemManager.GetInstances(XRInputSubsystems);
                 foreach (XRInputSubsystem xrInputSubsystem in XRInputSubsystems)
                 {
-                    if (xrInputSubsystem.running &&
-                        xrInputSubsystem.TryGetBoundaryPoints(boundaryGeometry) &&
-                        boundaryGeometry.Count > 0)
+                    if (xrInputSubsystem.running
+                        && xrInputSubsystem.GetTrackingOriginMode() == TrackingOriginModeFlags.Floor
+                        && xrInputSubsystem.TryGetBoundaryPoints(boundaryGeometry)
+                        && boundaryGeometry.Count > 0)
                     {
-                        return boundaryGeometry;
+                        break;
                     }
                 }
 #endif // UNITY_2019_3_OR_NEWER
-                return null;
             }
 
             return boundaryGeometry;
@@ -109,8 +94,19 @@ protected override void SetTrackingSpace()
                     break;
             }
 
-            if (XRSubsystemHelpers.InputSubsystem != null && !XRSubsystemHelpers.InputSubsystem.TrySetTrackingOriginMode(trackingOriginMode))
+            if (XRSubsystemHelpers.InputSubsystem == null || !XRSubsystemHelpers.InputSubsystem.TrySetTrackingOriginMode(trackingOriginMode))
             {
+#if UNITY_2019_3_OR_NEWER
+                // If the "main" input subsystem can't set the origin mode, check the rest of them
+                SubsystemManager.GetInstances(XRInputSubsystems);
+                foreach (XRInputSubsystem xrInputSubsystem in XRInputSubsystems)
+                {
+                    if (xrInputSubsystem.running && xrInputSubsystem.TrySetTrackingOriginMode(trackingOriginMode))
+                    {
+                        return;
+                    }
+                }
+#endif // UNITY_2019_3_OR_NEWER
                 Debug.LogWarning("Tracking origin unable to be set.");
             }
         }

Assets/MRTK/SDK/Profiles/HoloLens2/DefaultHoloLens2ConfigurationProfile.asset

@@ -25,7 +25,7 @@ MonoBehaviour:
   inputSystemProfile: {fileID: 11400000, guid: bec5ceabcd10992439d51532332137f9, type: 2}
   inputSystemType:
     reference: Microsoft.MixedReality.Toolkit.Input.MixedRealityInputSystem, Microsoft.MixedReality.Toolkit.Services.InputSystem
-  enableBoundarySystem: 0
+  enableBoundarySystem: 1
   boundarySystemType:
     reference: Microsoft.MixedReality.Toolkit.Boundary.MixedRealityBoundarySystem,
       Microsoft.MixedReality.Toolkit.Services.BoundarySystem

Assets/MRTK/Services/BoundarySystem/XR2018/MixedRealityBoundarySystem.cs

@@ -24,9 +24,6 @@ public MixedRealityBoundarySystem(
             MixedRealityBoundaryVisualizationProfile profile,
             ExperienceScale scale) : base(profile, scale) { }
 
-        /// <inheritdoc/>
-        protected override bool IsXRDevicePresent => XRDevice.isPresent;
-
         #region IMixedRealityService Implementation
 
         /// <inheritdoc/>

Assets/MRTK/Tests/PlayModeTests/BaseCursorTests.cs

@@ -22,7 +22,7 @@
 namespace Microsoft.MixedReality.Toolkit.Tests
 {
     // Tests to verify that cursor state is updated correctly
-    public class BaseCursorTests
+    public class BaseCursorTests : BasePlayModeTests
     {
         // Keeping this low by default so the test runs fast. Increase it to be able to see hand movements in the editor.
         private const int numFramesPerMove = 1;
@@ -41,10 +41,10 @@ public class BaseCursorTests
         /// for examples.
         /// See also comments at <see cref="TestUtilities.PlayspaceToArbitraryPose"/>.
         /// </remarks>
-        [UnitySetUp]
-        public IEnumerator SetUp()
+        public override IEnumerator Setup()
         {
-            PlayModeTestUtilities.Setup();
+            yield return base.Setup();
+
             TestUtilities.PlayspaceToArbitraryPose();
 
             // Target frame rate is set to 50 to match the physics
@@ -69,12 +69,10 @@ public IEnumerator SetUp()
             yield return null;
         }
 
-        [UnityTearDown]
-        public IEnumerator TearDown()
+        public override IEnumerator TearDown()
         {
             Object.Destroy(cube);
-            TestUtilities.ShutdownMixedRealityToolkit();
-            yield return null;
+            yield return base.TearDown();
         }
 
         private void VerifyCursorStateFromPointers(IEnumerable<IMixedRealityPointer> pointers, CursorStateEnum state)