implement isStationaryObserver, change default extents

Author: David Kline (ANALOG)

Assets/MixedRealityToolkit-Examples/Demos/SpatialAwareness/Scenes/SpatialAwarenessMeshDemo.unity

@@ -168,7 +168,10 @@ Prefab:
         your environment as a wireframe mesh.
 
 
-        Glance around your space and watch the mesh data appear.'
+        Move around your space and watch the mesh data appear.
+
+
+        As you move, meshes will appear in front of you and disappear behind you. '
       objectReference: {fileID: 0}
     - target: {fileID: 114713125240876806, guid: a900c08743a94c328074df8bbe3eb63c,
         type: 2}

Assets/MixedRealityToolkit-Examples/Demos/SpatialAwareness/Scripts.meta

@@ -96,6 +96,7 @@ private void InitializeInternal()
             // General settings
             StartupBehavior = MixedRealityManager.Instance.ActiveProfile.SpatialAwarenessProfile.StartupBehavior;
             ObservationExtents = MixedRealityManager.Instance.ActiveProfile.SpatialAwarenessProfile.ObservationExtents;
+            IsStationaryObserver = MixedRealityManager.Instance.ActiveProfile.SpatialAwarenessProfile.IsStationaryObserver;
             UpdateInterval = MixedRealityManager.Instance.ActiveProfile.SpatialAwarenessProfile.UpdateInterval;
 
             // Mesh settings
@@ -373,7 +374,10 @@ public int GetHashCode(object obj)
         public AutoStartBehavior StartupBehavior { get; set; } = AutoStartBehavior.AutoStart;
 
         /// <inheritdoc />
-        public Vector3 ObservationExtents { get; set; } = Vector3.one * 10;
+        public Vector3 ObservationExtents { get; set; } = Vector3.one * 3;
+
+        /// <inheritdoc />
+        public bool IsStationaryObserver { get; set; } = false;
 
         /// <inheritdoc />
         public Vector3 ObserverOrigin { get; set; } = Vector3.zero;

Assets/MixedRealityToolkit-Examples/Demos/SpatialAwareness/Scripts/SpatialObserverMover.cs

@@ -13,7 +13,8 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   isCustomProfile: 0
   startupBehavior: 0
-  observationExtents: {x: 10, y: 10, z: 10}
+  observationExtents: {x: 3, y: 3, z: 3}
+  isStationaryObserver: 0
   updateInterval: 3.5
   useMeshSystem: 1
   meshPhysicsLayer: 31

Assets/MixedRealityToolkit-Examples/Demos/SpatialAwareness/Scripts/SpatialObserverMover.cs.meta

@@ -25,13 +25,22 @@ public class MixedRealitySpatialAwarenessProfile : BaseMixedRealityProfile
 
         [SerializeField]
         [Tooltip("The dimensions of the spatial observer volume, in meters.")]
-        private Vector3 observationExtents = new Vector3(10f, 10f, 10f);
+        private Vector3 observationExtents = Vector3.one * 3;
 
         /// <summary>
         /// The size of the volume, in meters per axis, from which individual observations will be made.
         /// </summary>
         public Vector3 ObservationExtents => observationExtents;
 
+        [SerializeField]
+        [Tooltip("Should the spatial observer remain in a fixed location?")]
+        private bool isStationaryObserver = false;
+
+        /// <summary>
+        /// The size of the volume, in meters per axis, from which individual observations will be made.
+        /// </summary>
+        public bool IsStationaryObserver => isStationaryObserver;
+
         [SerializeField]
         [Tooltip("How often, in seconds, should the spatial observer update?")]
         private float updateInterval = 3.5f;

Assets/MixedRealityToolkit-SDK/Features/SpatialAwareness/System/MixedRealitySpatialAwarenessSystem.cs

@@ -3,16 +3,16 @@
 
 using Microsoft.MixedReality.Toolkit.Core.Definitions.SpatialAwarenessSystem;
 using Microsoft.MixedReality.Toolkit.Core.Definitions.Utilities;
+using Microsoft.MixedReality.Toolkit.Core.Interfaces.SpatialAwarenessSystem;
 using Microsoft.MixedReality.Toolkit.Core.Managers;
+using Microsoft.MixedReality.Toolkit.Core.Utilities;
 using UnityEngine;
 using System.Collections.Generic;
 
 #if UNITY_WSA
 using UnityEngine.XR.WSA;
 #endif // UNITY_WSA
 
-using UnityEngine.UI;
-
 namespace Microsoft.MixedReality.Toolkit.Core.Devices.SpatialAwareness
 {
     public class WindowsMixedRealitySpatialObserver : BaseSpatialObserver
@@ -82,6 +82,13 @@ public override void Destroy()
 
         #region IMixedRealitySpatialAwarenessObserver implementation
 
+        private IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem = null;
+
+        /// <summary>
+        /// The currently active instance of <see cref="IMixedRealitySpatialAwarenessSystem"/>.
+        /// </summary>
+        private IMixedRealitySpatialAwarenessSystem SpatialAwarenessSystem => spatialAwarenessSystem ?? (spatialAwarenessSystem = MixedRealityManager.SpatialAwarenessSystem);
+
 #if UNITY_WSA
         /// <summary>
         /// The surface observer providing the spatial data.
@@ -181,12 +188,14 @@ public override void StopObserving()
         /// </summary>
         private void CreateObserver()
         {
+            if (SpatialAwarenessSystem == null) { return; }
+
             if (observer == null)
             {
                 observer = new SurfaceObserver();
                 ConfigureObserverVolume();
 
-                if (MixedRealityManager.Instance.ActiveProfile.SpatialAwarenessProfile.StartupBehavior == AutoStartBehavior.AutoStart)
+                if (SpatialAwarenessSystem.StartupBehavior == AutoStartBehavior.AutoStart)
                 {
                     StartObserving();
                 }
@@ -239,6 +248,8 @@ private void CleanupObserver()
         /// </summary>
         private void UpdateObserver()
         {
+            if (SpatialAwarenessSystem == null) { return; }
+
             // Only update the observer if it is running.
             if (IsRunning && !outstandingMeshObject.HasValue)
             {
@@ -250,8 +261,14 @@ private void UpdateObserver()
                     RequestMesh(meshWorkQueue.Dequeue());
                 }
                 // If enough time has passed since the previous observer update...
-                else if (Time.time - lastUpdated >= MixedRealityManager.Instance.ActiveProfile.SpatialAwarenessProfile.UpdateInterval)
+                else if (Time.time - lastUpdated >= SpatialAwarenessSystem.UpdateInterval)
                 {
+                    // Update the observer location if it is not stationary
+                    if (!SpatialAwarenessSystem.IsStationaryObserver)
+                    {
+                        SpatialAwarenessSystem.ObserverOrigin = CameraCache.Main.transform.position;
+                    }
+
                     // The application can update the observer volume at any time, make sure we are using the latest.
                     ConfigureObserverVolume();
 
@@ -269,7 +286,6 @@ private void RequestMesh(SurfaceId surfaceId)
         {
             string meshName = ("SpatialMesh - " + surfaceId.handle);
 
-            // todo:
             SpatialMeshObject newMesh;
             WorldAnchor worldAnchor;
 
@@ -298,7 +314,7 @@ private void RequestMesh(SurfaceId surfaceId)
                 newMesh.Filter,
                 worldAnchor,
                 newMesh.Collider,
-                MixedRealityManager.SpatialAwarenessSystem.MeshTrianglesPerCubicMeter,
+                SpatialAwarenessSystem.MeshTrianglesPerCubicMeter,
                 true);
 
             if (observer.RequestMeshAsync(surfaceData, SurfaceObserver_OnDataReady))
@@ -331,7 +347,7 @@ protected void RemoveMeshObject(int id)
                 ReclaimMeshObject(mesh);
 
                 // Send the mesh removed event
-                MixedRealityManager.SpatialAwarenessSystem.RaiseMeshRemoved(id);
+                SpatialAwarenessSystem.RaiseMeshRemoved(id);
             }
         }
 
@@ -365,8 +381,8 @@ protected void ReclaimMeshObject(SpatialMeshObject availableMeshObject)
         /// </summary>
         private void ConfigureObserverVolume()
         {
-            Vector3 newExtents = MixedRealityManager.SpatialAwarenessSystem.ObservationExtents;
-            Vector3 newOrigin = MixedRealityManager.SpatialAwarenessSystem.ObserverOrigin;
+            Vector3 newExtents = SpatialAwarenessSystem.ObservationExtents;
+            Vector3 newOrigin = SpatialAwarenessSystem.ObserverOrigin;
 
             if (currentObserverExtents.Equals(newExtents) &&
                 currentObserverOrigin.Equals(newOrigin))
@@ -434,21 +450,21 @@ private void SurfaceObserver_OnDataReady(SurfaceData cookedData, bool outputWrit
             outstandingMeshObject = null;
 
             // Apply the appropriate material to the mesh.
-            SpatialMeshDisplayOptions displayOption = MixedRealityManager.SpatialAwarenessSystem.MeshDisplayOption;
+            SpatialMeshDisplayOptions displayOption = SpatialAwarenessSystem.MeshDisplayOption;
             if (displayOption != SpatialMeshDisplayOptions.None)
             {
                 meshObject.Renderer.enabled = true;
                 meshObject.Renderer.sharedMaterial = (displayOption == SpatialMeshDisplayOptions.Visible) ?
-                    MixedRealityManager.SpatialAwarenessSystem.MeshVisibleMaterial :
-                    MixedRealityManager.SpatialAwarenessSystem.MeshOcclusionMaterial;
+                    SpatialAwarenessSystem.MeshVisibleMaterial :
+                    SpatialAwarenessSystem.MeshOcclusionMaterial;
             }
             else
             {
                 meshObject.Renderer.enabled = false;
             }
 
             // Recalculate the mesh normals if requested.
-            if (MixedRealityManager.SpatialAwarenessSystem.MeshRecalculateNormals)
+            if (SpatialAwarenessSystem.MeshRecalculateNormals)
             {
                 meshObject.Filter.sharedMesh.RecalculateNormals();
             }
@@ -468,11 +484,11 @@ private void SurfaceObserver_OnDataReady(SurfaceData cookedData, bool outputWrit
 
             if (sendUpdatedEvent)
             {
-                MixedRealityManager.SpatialAwarenessSystem.RaiseMeshUpdated(cookedData.id.handle, meshObject.GameObject);
+                SpatialAwarenessSystem.RaiseMeshUpdated(cookedData.id.handle, meshObject.GameObject);
             }
             else
             {
-                MixedRealityManager.SpatialAwarenessSystem.RaiseMeshAdded(cookedData.id.handle, meshObject.GameObject);
+                SpatialAwarenessSystem.RaiseMeshAdded(cookedData.id.handle, meshObject.GameObject);
             }
         }
 #endif // UNITY_WSA

Assets/MixedRealityToolkit-SDK/Profiles/DefaultMixedRealitySpatialAwarenessProfile.asset

@@ -15,6 +15,7 @@ public class MixedRealitySpatialAwarenessProfileInspector : MixedRealityBaseConf
         // General settings
         private SerializedProperty startupBehavior;
         private SerializedProperty observationExtents;
+        private SerializedProperty isStationaryObserver;
         private SerializedProperty updateInterval;
 
         // Mesh settings
@@ -64,6 +65,7 @@ private void OnEnable()
             // General settings
             startupBehavior = serializedObject.FindProperty("startupBehavior");
             observationExtents = serializedObject.FindProperty("observationExtents");
+            isStationaryObserver = serializedObject.FindProperty("isStationaryObserver");
             updateInterval = serializedObject.FindProperty("updateInterval");
 
             // Mesh settings
@@ -118,6 +120,7 @@ public override void OnInspectorGUI()
             EditorGUILayout.LabelField("General Settings:", EditorStyles.boldLabel);
             EditorGUILayout.PropertyField(startupBehavior);
             EditorGUILayout.PropertyField(observationExtents);
+            EditorGUILayout.PropertyField(isStationaryObserver);
             EditorGUILayout.PropertyField(updateInterval);
 
             EditorGUILayout.Space();

Assets/MixedRealityToolkit/_Core/Definitions/SpatialAwareness/MixedRealitySpatialAwarenessProfile.cs

@@ -25,6 +25,15 @@ public interface IMixedRealitySpatialAwarenessSystem : IMixedRealityEventSystem,
         /// </summary>
         Vector3 ObservationExtents { get; set; }
 
+        /// <summary>
+        /// Should the observer remain stationary in the scene?
+        /// </summary>
+        /// <remarks>
+        /// Set IsStationaryObserver set to false, to move the volume with the user. 
+        /// If set to true, the origin will be 0,0,0 or the last known location.
+        /// </remarks>
+        bool IsStationaryObserver { get; set; }
+
         /// <summary>
         /// Gets or sets the origin of the observer.
         /// </summary>