Merge pull request #240 from darax/master

Create WorldAnchorManager to abstract saving and loading of persisted anchors

Author: NeerajW

Assets/HoloToolkit/SpatialMapping/Scripts/TapToPlace.cs

@@ -2,8 +2,6 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using UnityEngine;
-using UnityEngine.VR.WSA;
-using UnityEngine.VR.WSA.Persistence;
 
 namespace HoloToolkit.Unity
 {
@@ -24,144 +22,84 @@ public partial class TapToPlace : MonoBehaviour
         public string SavedAnchorFriendlyName = "SavedAnchorFriendlyName";
 
         /// <summary>
-        /// Keeps track of anchors stored on local device.
+        /// Manages persisted anchors.
         /// </summary>
-        WorldAnchorStore anchorStore = null;
+        private WorldAnchorManager anchorManager;
 
         /// <summary>
-        /// Locally saved wold anchor.
+        /// Controls spatial mapping.  In this script we access spatialMappingManager
+        /// to control rendering and to access the physics layer mask.
         /// </summary>
-        WorldAnchor savedAnchor;
-
-        bool placing = false;
-
-        void Start()
-        {
-            WorldAnchorStore.GetAsync(AnchorStoreReady);
-        }
+        private SpatialMappingManager spatialMappingManager;
 
         /// <summary>
-        /// Called when the local anchor store is ready.
+        /// Keeps track of if the user is moving the object or not.
         /// </summary>
-        /// <param name="store"></param>
-        void AnchorStoreReady(WorldAnchorStore store)
-        {
-            anchorStore = store;
+        private bool placing;
 
-            // Try to load a previously saved world anchor.
-            savedAnchor = anchorStore.Load(SavedAnchorFriendlyName, gameObject);
-            if (savedAnchor == null)
-            {
-                // Either world anchor was not saved / does not exist or has a different name.
-                Debug.Log(gameObject.name + " : "+ "World anchor could not be loaded for this game object. Creating a new anchor.");
-
-                // Create anchor since one does not exist.
-                CreateAnchor();
-            }
-            else
-            {
-                Debug.Log(gameObject.name + " : " + "World anchor loaded from anchor store and updated for this game object.");
-            }
-        }
-
-        // Called by GazeGestureManager when the user performs a tap gesture.
-        void OnSelect()
+        private void Start()
         {
-            if (SpatialMappingManager.Instance != null)
+            // Make sure we have all the components in the scene we need.
+            anchorManager = WorldAnchorManager.Instance;
+            if (anchorManager == null)
             {
-                // On each tap gesture, toggle whether the user is in placing mode.
-                placing = !placing;
-
-                // If the user is in placing mode, display the spatial mapping mesh.
-                if (placing)
-                {
-                    SpatialMappingManager.Instance.DrawVisualMeshes = true;
-
-                    Debug.Log(gameObject.name + " : " + "Removing existing world anchor if any.");
-
-                    // Remove existing world anchor when moving an object.
-                    DestroyImmediate(gameObject.GetComponent<WorldAnchor>());
-
-                    // Delete existing world anchor from anchor store when moving an object.
-                    if (anchorStore != null)
-                    {
-                        anchorStore.Delete(SavedAnchorFriendlyName);
-                    }
-                }
-                // If the user is not in placing mode, hide the spatial mapping mesh.
-                else
-                {
-                    SpatialMappingManager.Instance.DrawVisualMeshes = false;
-
-                    // Add world anchor when object placement is done.
-                    CreateAnchor();
-                }
+                Debug.LogError("This script expects that you have a WorldAnchorManager component in your scene.");
             }
-            else
-            {
-                Debug.Log("TapToPlace requires spatial mapping.  Try adding SpatialMapping prefab to project.");
-            }
-        }
-
-        private void CreateAnchor()
-        {
-            // NOTE: It's good practice to ensure your parent hierarchy or root game object does not already have a World Anchor.
-            // You can handle this in a way that works best for your application.
-            // For example: gameObject.transform.root.GetComponent<WorldAnchor>();
 
-            // Add the world anchor component when done moving an object.
-            WorldAnchor anchor = gameObject.AddComponent<WorldAnchor>();
-            if (anchor.isLocated)
+            spatialMappingManager = SpatialMappingManager.Instance;
+            if (spatialMappingManager == null)
             {
-                SaveAnchor(anchor);
+                Debug.LogError("This script expects that you have a SpatialMappingManager component in your scene.");
             }
-            else
-            {
-                anchor.OnTrackingChanged += Anchor_OnTrackingChanged;
-            }
-        }
 
-        private void SaveAnchor(WorldAnchor anchor)
-        {
-            // Save the anchor to persist holograms across sessions.
-            if (anchorStore.Save(SavedAnchorFriendlyName, anchor))
+            if (anchorManager != null && spatialMappingManager != null)
             {
-                Debug.Log(gameObject.name + " : " + "World anchor saved successfully.");
+                anchorManager.AttachAnchor(this.gameObject, SavedAnchorFriendlyName);
             }
             else
             {
-                Debug.LogError(gameObject.name + " : " + "World anchor save failed.");
+                // If we don't have what we need to proceed, we may as well remove ourselves.
+                Destroy(this);
             }
         }
 
-        private void Anchor_OnTrackingChanged(WorldAnchor self, bool located)
+        // Called by GazeGestureManager when the user performs a tap gesture.
+        public void OnSelect()
         {
-            if (located)
+            // On each tap gesture, toggle whether the user is in placing mode.
+            placing = !placing;
+
+            // If the user is in placing mode, display the spatial mapping mesh.
+            if (placing)
             {
-                Debug.Log(gameObject.name + " : " + "World anchor located successfully.");
+                spatialMappingManager.DrawVisualMeshes = true;
+
+                Debug.Log(gameObject.name + " : Removing existing world anchor if any.");
 
-                SaveAnchor(self);
-                self.OnTrackingChanged -= Anchor_OnTrackingChanged;
+                anchorManager.RemoveAnchor(gameObject);
             }
+            // If the user is not in placing mode, hide the spatial mapping mesh.
             else
             {
-                Debug.LogError(gameObject.name + " : " + "World anchor failed to locate.");
+                spatialMappingManager.DrawVisualMeshes = false;
+                // Add world anchor when object placement is done.
+                anchorManager.AttachAnchor(gameObject, SavedAnchorFriendlyName);
             }
         }
 
-        void Update()
+        private void Update()
         {
-                // If the user is in placing mode,
-                // update the placement to match the user's gaze.
-                if (placing)
+            // If the user is in placing mode,
+            // update the placement to match the user's gaze.
+            if (placing)
             {
                 // Do a raycast into the world that will only hit the Spatial Mapping mesh.
                 var headPosition = Camera.main.transform.position;
                 var gazeDirection = Camera.main.transform.forward;
 
                 RaycastHit hitInfo;
                 if (Physics.Raycast(headPosition, gazeDirection, out hitInfo,
-                    30.0f, SpatialMappingManager.Instance.LayerMask))
+                    30.0f, spatialMappingManager.LayerMask))
                 {
                     // Move this object to where the raycast
                     // hit the Spatial Mapping mesh.

Assets/HoloToolkit/SpatialMapping/Tests/TapToPlace.unity

@@ -37,7 +37,7 @@ RenderSettings:
   m_ReflectionIntensity: 1
   m_CustomReflection: {fileID: 0}
   m_Sun: {fileID: 0}
-  m_IndirectSpecularColor: {r: 0.44692582, g: 0.4967878, b: 0.5750859, a: 1}
+  m_IndirectSpecularColor: {r: 0.44692558, g: 0.49678743, b: 0.57508624, a: 1}
 --- !u!157 &3
 LightmapSettings:
   m_ObjectHideFlags: 0
@@ -323,6 +323,7 @@ GameObject:
   - 4: {fileID: 2116021332}
   - 114: {fileID: 2116021331}
   - 114: {fileID: 2116021330}
+  - 114: {fileID: 2116021333}
   m_Layer: 0
   m_Name: Managers
   m_TagString: Untagged
@@ -373,6 +374,17 @@ Transform:
   m_Children: []
   m_Father: {fileID: 0}
   m_RootOrder: 3
+--- !u!114 &2116021333
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_PrefabParentObject: {fileID: 0}
+  m_PrefabInternal: {fileID: 0}
+  m_GameObject: {fileID: 2116021329}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: f122ca4ae6b527e4798205becf9a0550, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
 --- !u!1 &2138978090
 GameObject:
   m_ObjectHideFlags: 0