Workaround for new OpenXR issue. (#187)

fast-slow-still · web-flow · commit 6ce01cdcb48c · 2021-07-31T10:01:50.000+01:00
* Workaround for new OpenXR issue. OpenXR is now returning a session subsystem, but the session always (incorrectly) reports tracking state = None. Ignoring.

* Update UPM generation files to v1.4.1.

* Add 1 second delay in bootstrap to give ASA Spatial Anchor Manager time to finish starting before trying to utilize it.

* Conditionally for Unity 2020.4 or newer, switch to new AddComponent&lt;ARAnchor&gt; pattern, from old anchrMgr.AddAnchor().
It looks like the AddComponent&lt;ARAnchor&gt; started working sometime between U2020.3.2f1 (doesn't work) and U2020.3.8f1 (does work).

* Update supported versions for ASA.
diff --git a/Assets/WorldLocking.ASA.Examples/Scenes/PinTestSofa.unity b/Assets/WorldLocking.ASA.Examples/Scenes/PinTestSofa.unity
diff --git a/Assets/WorldLocking.ASA/Scripts/PublisherASA.cs b/Assets/WorldLocking.ASA/Scripts/PublisherASA.cs
@@ -348,10 +348,13 @@ public async void Setup()
             asaManager.AnchorLocated += OnAnchorLocated;
             asaManager.LocateAnchorsCompleted += OnAnchorLocateCompleted;
 
+            int delayBeforeCreateMS = 1000;
+            await Task.Delay(delayBeforeCreateMS);
+
             Debug.Log($"To create session");
             await asaManager.CreateSessionAsync();
 
-            int delayBeforeStartMS = 3000;
+            int delayBeforeStartMS = 2000;
             await Task.Delay(delayBeforeStartMS);
 
             Debug.Log($"To start session");
diff --git a/Assets/WorldLocking.Core/Scripts/ARF/AnchorManagerARF.cs b/Assets/WorldLocking.Core/Scripts/ARF/AnchorManagerARF.cs
@@ -3,6 +3,10 @@
 
 #if UNITY_2020_1_OR_NEWER
 
+#if UNITY_2020_4_OR_NEWER
+#define WLT_ADD_ANCHOR_COMPONENT
+#endif // UNITY_2020_4_OR_NEWER
+
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
@@ -127,6 +131,14 @@ protected override SpongyAnchor CreateAnchor(AnchorId id, Transform parent, Pose
             Debug.Log($"Creating anchor {id.FormatStr()}");
 #endif // WLT_EXTRA_LOGGING
             initialPose = AnchorFromSpongy.Multiply(initialPose);
+#if WLT_ADD_ANCHOR_COMPONENT
+            GameObject go = new GameObject(id.FormatStr());
+            go.transform.SetParent(parent);
+            go.transform.SetGlobalPose(initialPose);
+            go.AddComponent<ARAnchor>();
+            SpongyAnchorARF newAnchor = go.AddComponent<SpongyAnchorARF>();
+            return newAnchor;
+#else // WLT_ADD_ANCHOR_COMPONENT
             var arAnchor = arAnchorManager.AddAnchor(initialPose);
             if (arAnchor == null)
             {
@@ -136,6 +148,7 @@ protected override SpongyAnchor CreateAnchor(AnchorId id, Transform parent, Pose
             arAnchor.gameObject.name = id.FormatStr();
             SpongyAnchorARF newAnchor =  arAnchor.gameObject.AddComponent<SpongyAnchorARF>();
             return newAnchor;
+#endif // WLT_ADD_ANCHOR_COMPONENT
         }
 
         protected override SpongyAnchor DestroyAnchor(AnchorId id, SpongyAnchor spongyAnchor)
diff --git a/Assets/WorldLocking.Core/Scripts/ARF/SpongyAnchorARF.cs b/Assets/WorldLocking.Core/Scripts/ARF/SpongyAnchorARF.cs
@@ -3,6 +3,10 @@
 
 #if UNITY_2020_1_OR_NEWER
 
+#if UNITY_2020_4_OR_NEWER
+#define WLT_ADD_ANCHOR_COMPONENT
+#endif // UNITY_2020_4_OR_NEWER
+
 using UnityEngine;
 #if WLT_ARFOUNDATION_PRESENT
 using UnityEngine.XR.ARFoundation;
@@ -122,11 +126,15 @@ private void Start ()
 #if WLT_ARFOUNDATION_PRESENT
         public void Cleanup(ARAnchorManager arAnchorManager)
         {
+#if WLT_ADD_ANCHOR_COMPONENT
+            GameObject.Destroy(gameObject);
+#else // WLT_ADD_ANCHOR_COMPONENT
             if ((arAnchorManager != null) && (arAnchor != null))
             {
                 arAnchorManager.RemoveAnchor(arAnchor);
                 arAnchor = null;
             }
+#endif // WLT_ADD_ANCHOR_COMPONENT
         }
 #endif // WLT_ARFOUNDATION_PRESENT
 
diff --git a/Assets/WorldLocking.Core/Scripts/WorldLockingManager.cs b/Assets/WorldLocking.Core/Scripts/WorldLockingManager.cs
@@ -29,7 +29,7 @@ public class WorldLockingManager
         /// allowing quick visual verification of the version of World Locking Tools for Unity currently installed.
         /// It has no effect in code, but serves only as a label.
         /// </summary>
-        public static string Version => "1.4.0";
+        public static string Version => "1.4.1";
 
         /// <summary>
         /// The configuration settings may only be set as a block.
diff --git a/Assets/WorldLocking.Core/Scripts/XR/AnchorManagerXR.cs b/Assets/WorldLocking.Core/Scripts/XR/AnchorManagerXR.cs
@@ -130,7 +130,7 @@ private static XRAnchorSubsystem FindAnchorManager()
                     {
                         activeSubsystem = sub;
                         ++numFound;
-                        Debug.Log($"Start changed an anchor subsystem to running.");
+                        Debug.Log($"Start changed anchor subsystem {sub.subsystemDescriptor.id} to running.");
                     }
                 }
             }
@@ -150,6 +150,17 @@ private static XRAnchorSubsystem FindAnchorManager()
         /// </remarks>
         private static XRSessionSubsystem FindSessionSubsystem()
         {
+#if WLT_XR_MANAGEMENT_PRESENT
+            /// Workaround. OpenXR is now returning a SessionSubsystem, but it is reporting 
+            /// its trackingStatus as TrackingStatus.None forever. Since the (incorrect) tracking status
+            /// is all we want the XRSessionSubsystem for, leave it as null for now.
+            bool isOpenXR = XRGeneralSettings.Instance.Manager.activeLoader.name.StartsWith("Open XR");
+            if (isOpenXR)
+            {
+                return null;
+            }
+#endif // WLT_XR_MANAGEMENT_PRESENT
+
             List<XRSessionSubsystem> sessionSubsystems = new List<XRSessionSubsystem>();
             SubsystemManager.GetInstances(sessionSubsystems);
             Debug.Log($"Found {sessionSubsystems.Count} session subsystems");
@@ -159,7 +170,7 @@ private static XRSessionSubsystem FindSessionSubsystem()
             {
                 if (session.running)
                 {
-                    Debug.Log($"Found active session subsystem");
+                    Debug.Log($"Found active session subsystem {session.subsystemDescriptor.id}");
                     activeSession = session;
                     ++numFound;
                 }
@@ -174,7 +185,7 @@ private static XRSessionSubsystem FindSessionSubsystem()
                     {
                         activeSession = session;
                         ++numFound;
-                        Debug.Log($"Start changed a session to running.");
+                        Debug.Log($"Start changed session {session.subsystemDescriptor.id} to running.");
                     }
                 }
             }
@@ -335,8 +346,10 @@ protected override bool IsTracking()
             /// Currently a problem obtaining the sessionSubsystem in OpenXR. Until that is remediated,
             /// we will assume that if we have no sessionSubsystem, then tracking is fine.
             if (sessionSubsystem == null)
+            {
                 return true;
-            //Debug.Log($"AnchorManagerXR F{Time.frameCount}: session is {(sessionSubsystem != null && sessionSubsystem.running ? "running" : "null")} and {(sessionSubsystem != null && sessionSubsystem.trackingState != TrackingState.None ? "tracking" : "not-tracking")}");
+            }
+            //Debug.Log($"AMXR F{Time.frameCount} session running={sessionSubsystem.running} state={sessionSubsystem.trackingState}");
             return sessionSubsystem != null
                 && sessionSubsystem.running
                 && sessionSubsystem.trackingState != TrackingState.None;
diff --git a/DocGen/Documentation/HowTos/Samples/WLT_ASA_Sample.md b/DocGen/Documentation/HowTos/Samples/WLT_ASA_Sample.md
@@ -25,10 +25,10 @@ This sample provides assets and scripts to:
 
 This sample has been developed and tested using:
 
-* Unity 2020.3.2f1
-* Azure Spatial Anchors (ASA) v2.9.0
+* Unity 2020.3.8f1
+* Azure Spatial Anchors (ASA) v2.9.0 - v2.10.2.
 * Mixed Reality Toolkit v2.7.2
-* World Locking Tools for Unity v1.4.0
+* World Locking Tools for Unity v1.4.1
 * FrozenWorldEngine v1.1.1
 
 You can install WLT and this sample either from [WLT releases .unitypackage](https://github.com/microsoft/MixedReality-WorldLockingTools-Unity/releases) or from the Mixed Reality Feature Tool. Note that if installing from the FeatureTool, you must not only install the WLT Examples dependency (automatic), but also Import the Examples into your project. See [Installing WLT from MR Feature Tool](../WLTviaMRFeatureTool.md) for details.
diff --git a/UPM/asa_files/CHANGELOG.md b/UPM/asa_files/CHANGELOG.md
@@ -2,4 +2,6 @@
 
 [See release notes](https://github.com/microsoft/MixedReality-WorldLockingTools-Unity/releases)
 
+## 1.4.1 - Workaround for OpenXR session tracking state issue.
+
 ## 1.4.0 - Initial release
diff --git a/UPM/asa_files/package.json b/UPM/asa_files/package.json
@@ -1,7 +1,7 @@
 {
   "name": "com.microsoft.mixedreality.wlt.asa",
   "displayName": "WLT-ASA",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "unity": "2020.3",
   "msftFeatureCategory": "World Locking Tools",
   "description": "World Locking Tools for Unity (WLT) + Azure Spatial Anchors (ASA)\n\nThis optional add-on to WLT leverages ASA to persist coordinate spaces across sessions and share them across devices.\nCross platform support includes HoloLens, Android, and iOS.",
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "com.microsoft.azure.spatial-anchors-sdk.core": "2.9.0",
-    "com.microsoft.mixedreality.worldlockingtools": "1.4.0"
+    "com.microsoft.mixedreality.worldlockingtools": "1.4.1"
   },
   "files": [
     "WorldLocking.ASA",
diff --git a/UPM/asa_samples_files/CHANGELOG.md b/UPM/asa_samples_files/CHANGELOG.md
@@ -2,4 +2,6 @@
 
 [See release notes](https://github.com/microsoft/MixedReality-WorldLockingTools-Unity/releases)
 
+## 1.4.1 - Workaround for OpenXR session tracking state issue.
+
 ## 1.4.0 - Initial release
diff --git a/UPM/asa_samples_files/package.json b/UPM/asa_samples_files/package.json
@@ -1,7 +1,7 @@
 {
   "name": "com.microsoft.mixedreality.wlt.asa.samples",
   "displayName": "WLT-ASA Samples",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "unity": "2020.3",
   "msftFeatureCategory" : "World Locking Tools",
   "description": "Example scenes and scripts leveraging Azure Space Anchors (ASA) to persist World Locked coordinate spaces across sessions and share across devices.\n\nFurther samples available at\nhttps://microsoft.github.io/MixedReality-WorldLockingTools-Samples/README.html",
@@ -36,9 +36,9 @@
   "dependencies": {
     "com.microsoft.azure.spatial-anchors-sdk.core": "2.9.0",
     "com.microsoft.mixedreality.toolkit.foundation": "2.7.0",
-    "com.microsoft.mixedreality.wlt.asa": "1.4.0",
-    "com.microsoft.mixedreality.worldlockingtools": "1.4.0",
-    "com.microsoft.mixedreality.worldlockingsamples": "1.4.0"
+    "com.microsoft.mixedreality.wlt.asa": "1.4.1",
+    "com.microsoft.mixedreality.worldlockingtools": "1.4.1",
+    "com.microsoft.mixedreality.worldlockingsamples": "1.4.1"
   },
   "files": [
     "package.json.meta",
diff --git a/UPM/core_files/CHANGELOG.md b/UPM/core_files/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 [See release notes](https://github.com/microsoft/MixedReality-WorldLockingTools-Unity/releases)
 
+## 1.4.1 - Workaround for OpenXR tracking state issue.
+
 ## 1.4.0 - Optional integration of Azure Spatial Anchors for persistence and sharing.
 
 ## 1.3.5 - Automated setup from MRTK Unity menu.
diff --git a/UPM/core_files/package.json b/UPM/core_files/package.json
@@ -1,7 +1,7 @@
 {
   "name": "com.microsoft.mixedreality.worldlockingtools",
   "displayName": "WLT Core",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "unity": "2019.4",
   "msftFeatureCategory" : "World Locking Tools",
   "description": "World Locking Tools for Unity (WLT)\n\nLock AR virtual space to physical space automatically and intuitively, without requiring application management of anchors.\nPreserve object relative layout, while remaining perceptually stationary in the physical world.",
diff --git a/UPM/samples_files/CHANGELOG.md b/UPM/samples_files/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 [See release notes](https://github.com/microsoft/MixedReality-WorldLockingTools-Unity/releases)
 
+## 1.4.1 - Workaround for OpenXR session tracking state issue.
+
 ## 1.4.0 - Optional integration of Azure Spatial Anchors for persistence and sharing.
 
 ## 1.3.5 - Dependency on WLT v1.3.5 for automated setup tools.
diff --git a/UPM/samples_files/package.json b/UPM/samples_files/package.json
@@ -1,7 +1,7 @@
 {
   "name": "com.microsoft.mixedreality.worldlockingsamples",
   "displayName": "WLT Samples",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "unity": "2019.4",
   "msftFeatureCategory" : "World Locking Tools",
   "description": "Basic examples for World Locking Tools.\n\nFurther samples available at\nhttps://microsoft.github.io/MixedReality-WorldLockingTools-Samples/README.html",
@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "com.microsoft.mixedreality.toolkit.foundation": "2.7.0",
-    "com.microsoft.mixedreality.worldlockingtools": "1.4.0"
+    "com.microsoft.mixedreality.worldlockingtools": "1.4.1"
   },
   "files": [
     "package.json.meta",

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,10 @@`
`3`	`3`
`4`	`4`	`#if UNITY_2020_1_OR_NEWER`
`5`	`5`
	`6`	`+#if UNITY_2020_4_OR_NEWER`
	`7`	`+#define WLT_ADD_ANCHOR_COMPONENT`
	`8`	`+#endif // UNITY_2020_4_OR_NEWER`
	`9`	`+`
`6`	`10`	`using UnityEngine;`
`7`	`11`	`#if WLT_ARFOUNDATION_PRESENT`
`8`	`12`	`using UnityEngine.XR.ARFoundation;`
`@@ -122,11 +126,15 @@ private void Start ()`
`122`	`126`	`#if WLT_ARFOUNDATION_PRESENT`
`123`	`127`	`public void Cleanup(ARAnchorManager arAnchorManager)`
`124`	`128`	`{`
	`129`	`+#if WLT_ADD_ANCHOR_COMPONENT`
	`130`	`+ GameObject.Destroy(gameObject);`
	`131`	`+#else // WLT_ADD_ANCHOR_COMPONENT`
`125`	`132`	`if ((arAnchorManager != null) && (arAnchor != null))`
`126`	`133`	`{`
`127`	`134`	`arAnchorManager.RemoveAnchor(arAnchor);`
`128`	`135`	`arAnchor = null;`
`129`	`136`	`}`
	`137`	`+#endif // WLT_ADD_ANCHOR_COMPONENT`
`130`	`138`	`}`
`131`	`139`	`#endif // WLT_ARFOUNDATION_PRESENT`
`132`	`140`
Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ private static XRAnchorSubsystem FindAnchorManager()`
`130`	`130`	`{`
`131`	`131`	`activeSubsystem = sub;`
`132`	`132`	`++numFound;`
`133`		`- Debug.Log($"Start changed an anchor subsystem to running.");`
	`133`	`+ Debug.Log($"Start changed anchor subsystem {sub.subsystemDescriptor.id} to running.");`
`134`	`134`	`}`
`135`	`135`	`}`
`136`	`136`	`}`
`@@ -150,6 +150,17 @@ private static XRAnchorSubsystem FindAnchorManager()`
`150`	`150`	`/// </remarks>`
`151`	`151`	`private static XRSessionSubsystem FindSessionSubsystem()`
`152`	`152`	`{`
	`153`	`+#if WLT_XR_MANAGEMENT_PRESENT`
	`154`	`+ /// Workaround. OpenXR is now returning a SessionSubsystem, but it is reporting`
	`155`	`+ /// its trackingStatus as TrackingStatus.None forever. Since the (incorrect) tracking status`
	`156`	`+ /// is all we want the XRSessionSubsystem for, leave it as null for now.`
	`157`	`+ bool isOpenXR = XRGeneralSettings.Instance.Manager.activeLoader.name.StartsWith("Open XR");`
	`158`	`+ if (isOpenXR)`
	`159`	`+ {`
	`160`	`+ return null;`
	`161`	`+ }`
	`162`	`+#endif // WLT_XR_MANAGEMENT_PRESENT`
	`163`	`+`
`153`	`164`	`List<XRSessionSubsystem> sessionSubsystems = new List<XRSessionSubsystem>();`
`154`	`165`	`SubsystemManager.GetInstances(sessionSubsystems);`
`155`	`166`	`Debug.Log($"Found {sessionSubsystems.Count} session subsystems");`
`@@ -159,7 +170,7 @@ private static XRSessionSubsystem FindSessionSubsystem()`
`159`	`170`	`{`
`160`	`171`	`if (session.running)`
`161`	`172`	`{`
`162`		`- Debug.Log($"Found active session subsystem");`
	`173`	`+ Debug.Log($"Found active session subsystem {session.subsystemDescriptor.id}");`
`163`	`174`	`activeSession = session;`
`164`	`175`	`++numFound;`
`165`	`176`	`}`
`@@ -174,7 +185,7 @@ private static XRSessionSubsystem FindSessionSubsystem()`
`174`	`185`	`{`
`175`	`186`	`activeSession = session;`
`176`	`187`	`++numFound;`
`177`		`- Debug.Log($"Start changed a session to running.");`
	`188`	`+ Debug.Log($"Start changed session {session.subsystemDescriptor.id} to running.");`
`178`	`189`	`}`
`179`	`190`	`}`
`180`	`191`	`}`
`@@ -335,8 +346,10 @@ protected override bool IsTracking()`
`335`	`346`	`/// Currently a problem obtaining the sessionSubsystem in OpenXR. Until that is remediated,`
`336`	`347`	`/// we will assume that if we have no sessionSubsystem, then tracking is fine.`
`337`	`348`	`if (sessionSubsystem == null)`
	`349`	`+ {`
`338`	`350`	`return true;`
`339`		`- //Debug.Log($"AnchorManagerXR F{Time.frameCount}: session is {(sessionSubsystem != null && sessionSubsystem.running ? "running" : "null")} and {(sessionSubsystem != null && sessionSubsystem.trackingState != TrackingState.None ? "tracking" : "not-tracking")}");`
	`351`	`+ }`
	`352`	`+ //Debug.Log($"AMXR F{Time.frameCount} session running={sessionSubsystem.running} state={sessionSubsystem.trackingState}");`
`340`	`353`	`return sessionSubsystem != null`
`341`	`354`	`&& sessionSubsystem.running`
`342`	`355`	`&& sessionSubsystem.trackingState != TrackingState.None;`