Fix issues associated with the new SU package

Author: MaxWang-MS

Assets/MRTK/Providers/Experimental/WindowsSceneUnderstanding/Editor/WindowsSceneUnderstandingConfigChecker.cs

@@ -12,7 +12,7 @@ namespace Microsoft.MixedReality.Toolkit.WindowsSceneUnderstanding.Experimental
     /// </summary>
     static class WindowsSceneUnderstandingConfigurationChecker
     {
-        private const string FileName = "Microsoft.MixedReality.SceneUnderstanding.DotNet.dll";
+        private const string FileName = "Microsoft.MixedReality.SceneUnderstanding.dll";
         private static readonly string[] definitions = { "SCENE_UNDERSTANDING_PRESENT" };
 
         /// <summary>

Assets/MRTK/Providers/Experimental/WindowsSceneUnderstanding/MRTK.WSU.asmdef

@@ -3,7 +3,9 @@
     "references": [
         "Microsoft.MixedReality.Toolkit",
         "Microsoft.MixedReality.Toolkit.Async",
-        "Microsoft.MixedReality.Toolkit.Providers.WindowsMixedReality.Shared"
+        "Microsoft.MixedReality.Toolkit.Providers.WindowsMixedReality.Shared",
+        "Microsoft.MixedReality.SceneUnderstanding.Projections.Editor",
+        "Microsoft.MixedReality.SceneUnderstanding.Projections.WSA"
     ],
     "optionalUnityReferences": [],
     "includePlatforms": [
@@ -15,5 +17,13 @@
     "overrideReferences": false,
     "precompiledReferences": [],
     "autoReferenced": true,
-    "defineConstraints": []
+    "defineConstraints": [],
+    "versionDefines": [
+        {
+            "name": "com.microsoft.mixedreality.sceneunderstanding",
+            "expression": "",
+            "define": "SCENE_UNDERSTANDING_PRESENT"
+        }
+    ],
+    "noEngineReferences": false
 }

Assets/MRTK/Providers/Experimental/WindowsSceneUnderstanding/WindowsSceneUnderstandingObserver.cs

@@ -97,25 +97,33 @@ private void ReadProfile()
             OrientScene = profile.OrientScene;
         }
 
-#if SCENE_UNDERSTANDING_PRESENT
-
         #region IMixedRealityService
 
+#if SCENE_UNDERSTANDING_PRESENT
+
         /// <inheritdoc />
         public override void Reset()
         {
             CleanupObserver();
             Initialize();
         }
 
+#endif // SCENE_UNDERSTANDING_PRESENT
+
         /// <inheritdoc />
         public override void Initialize()
         {
             base.Initialize();
+#if !SCENE_UNDERSTANDING_PRESENT
+            if (Application.isPlaying)
+            {
+                Debug.LogWarning("The required package Microsoft.MixedReality.SceneUnderstanding is not installed or properly configured. Please visit https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/spatial-awareness/scene-understanding for more information.");
+            }
+#else
             sceneEventData = new MixedRealitySpatialAwarenessEventData<SpatialAwarenessSceneObject>(EventSystem.current);
             CreateQuadFromExtents(normalizedQuadMesh, 1, 1);
 
-            var accessStatus = SceneObserver.RequestAccessAsync().GetAwaiter().GetResult();
+            SceneObserverAccessStatus accessStatus = Task.Run(RequestAccess).GetAwaiter().GetResult();
             if (accessStatus == SceneObserverAccessStatus.Allowed)
             {
                 IsRunning = true;
@@ -131,18 +139,18 @@ public override void Initialize()
             {
                 observerState = ObserverState.GetScene;
             }
+#endif // SCENE_UNDERSTANDING_PRESENT
         }
 
+#if SCENE_UNDERSTANDING_PRESENT
+
         /// <inheritdoc />
         public override void Enable()
         {
             // Terminate the background thread when we stop in editor.
             cancelToken = cancelTokenSource.Token;
 
-            // there is odd behavior with WaitForBackgroundTask
-            // it will sometimes run on the main thread unless we start it this way
-            task = RunObserverAsync(cancelToken);
-            task.ConfigureAwait(true);
+            task = Task.Run(() => RunObserverAsync(cancelToken));
         }
 
         /// <inheritdoc />
@@ -171,8 +179,12 @@ public override void Destroy()
             CleanupObserver();
         }
 
+#endif // SCENE_UNDERSTANDING_PRESENT
+
         #endregion IMixedRealityService
 
+#if SCENE_UNDERSTANDING_PRESENT
+
         #region BaseService
 
         /// <inheritdoc />
@@ -280,7 +292,7 @@ public IReadOnlyDictionary<int, SpatialAwarenessSceneObject> SceneObjects
         public void SaveScene(string filenamePrefix)
         {
 #if WINDOWS_UWP && SCENE_UNDERSTANDING_PRESENT
-            SaveToFile(filenamePrefix);
+            Task.Run(() => SaveToFile(filenamePrefix));
 #else // WINDOWS_UWP
             Debug.LogWarning("SaveScene() only supported at runtime! Ignoring request.");
 #endif // WINDOWS_UWP
@@ -523,6 +535,11 @@ protected virtual void SendSceneObjectRemoved(int id)
             SpatialAwarenessSystem?.HandleEvent(sceneEventData, OnSceneObjectRemoved);
         }
 
+        private async Task<SceneObserverAccessStatus> RequestAccess()
+        {
+            return await SceneObserver.RequestAccessAsync();
+        }
+
         /// <summary>
         /// Sets up and starts update timers
         /// </summary>
@@ -630,7 +647,7 @@ private async Task RunObserverAsync(CancellationToken cancellationToken)
                         }
                         await new WaitForBackgroundThread();
                         {
-                            scene = GetSceneAsync(previousScene);
+                            scene = await GetSceneAsync(previousScene);
                             previousScene = scene;
                             sceneOriginId = scene.OriginSpatialGraphNodeId;
                         }
@@ -761,7 +778,7 @@ private System.Numerics.Matrix4x4 GetSceneToWorldTransform()
         /// </summary>
         /// <param name="previousScene">The previous scene</param>
         /// <returns>The retrieved scene</returns>
-        private Scene GetSceneAsync(Scene previousScene)
+        private async Task<Scene> GetSceneAsync(Scene previousScene)
         {
             Scene scene = null;
 
@@ -795,18 +812,13 @@ private Scene GetSceneAsync(Scene previousScene)
                     RequestedMeshLevelOfDetail = LevelOfDetailToMeshLOD(WorldMeshLevelOfDetail)
                 };
 
-                // Ideally you'd call SceneObserver.ComputeAsync() like this:
-                // scene = await SceneObserver.ComputeAsync(...);
-                // however this has been problematic (buggy?)
-                // For the time being we force it to be synchronous with the ...GetAwaiter().GetResult() pattern
-
                 if (UsePersistentObjects && previousScene != null)
                 {
-                    scene = SceneObserver.ComputeAsync(sceneQuerySettings, QueryRadius, previousScene).GetAwaiter().GetResult();
+                    scene = await SceneObserver.ComputeAsync(sceneQuerySettings, QueryRadius, previousScene);
                 }
                 else
                 {
-                    scene = SceneObserver.ComputeAsync(sceneQuerySettings, QueryRadius).GetAwaiter().GetResult();
+                    scene = await SceneObserver.ComputeAsync(sceneQuerySettings, QueryRadius);
                 }
             }
 
@@ -1301,7 +1313,7 @@ private async void SaveToFile(string prefix)
                 RequestedMeshLevelOfDetail = LevelOfDetailToMeshLOD(WorldMeshLevelOfDetail)
             };
 
-            var serializedScene = SceneObserver.ComputeSerializedAsync(sceneQuerySettings, QueryRadius).GetAwaiter().GetResult();
+            var serializedScene = await SceneObserver.ComputeSerializedAsync(sceneQuerySettings, QueryRadius);
             var bytes = new byte[serializedScene.Size];
             serializedScene.GetData(bytes);
             var timestamp = DateTime.Now.ToString("yyyyMMdd_hhmmss");