addressing feedback from review

Author: darax

Assets/HoloToolkit/SpatialMapping/Scripts/TapToPlace.cs

@@ -26,42 +26,64 @@ public partial class TapToPlace : MonoBehaviour
         /// </summary>
         WorldAnchorManager anchorManager;
 
+        /// <summary>
+        /// Controls spatial mapping.  In this script we access spatialMappingManager
+        /// to control rendering and to access the physics layer mask.
+        /// </summary>
+        SpatialMappingManager spatialMappingManager;
+
+        /// <summary>
+        /// Keeps track of if the user is moving the object or not.
+        /// </summary>
         bool placing = false;
 
         void Start()
         {
+            // Make sure we have all the components in the scene we need.
             anchorManager = WorldAnchorManager.Instance;
-            anchorManager.AttachAnchor(this.gameObject, SavedAnchorFriendlyName);
+            if (anchorManager == null)
+            {
+                Debug.LogError("This script expects that you have a WorldAnchorManager component in your scene.");
+            }
+
+            spatialMappingManager = SpatialMappingManager.Instance;
+            if (spatialMappingManager == null)
+            {
+                Debug.LogError("This script expects that you have a SpatialMappingManager component in your scene.");
+            }
+
+            if (anchorManager != null && spatialMappingManager != null)
+            {
+                anchorManager.AttachAnchor(this.gameObject, SavedAnchorFriendlyName);
+            }
+            else
+            {
+                // If we don't have what we need to proceed, we may as well remove ourselves.
+                Destroy(this);
+            }
         }
 
         // Called by GazeGestureManager when the user performs a tap gesture.
         void OnSelect()
         {
-            if (SpatialMappingManager.Instance != null)
-            {
-                // On each tap gesture, toggle whether the user is in placing mode.
-                placing = !placing;
+            // 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;
+            // If the user is in placing mode, display the spatial mapping mesh.
+            if (placing)
+            {
+                spatialMappingManager.DrawVisualMeshes = true;
 
-                    Debug.Log(gameObject.name + " : Removing existing world anchor if any.");
+                Debug.Log(gameObject.name + " : Removing existing world anchor if any.");
 
-                    anchorManager.RemoveAnchor(gameObject);
-                }
-                // 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.
-                    anchorManager.AttachAnchor(gameObject, SavedAnchorFriendlyName);
-                }
+                anchorManager.RemoveAnchor(gameObject);
             }
+            // If the user is not in placing mode, hide the spatial mapping mesh.
             else
             {
-                Debug.Log("TapToPlace requires spatial mapping.  Try adding SpatialMapping prefab to project.");
+                spatialMappingManager.DrawVisualMeshes = false;
+                // Add world anchor when object placement is done.
+                anchorManager.AttachAnchor(gameObject, SavedAnchorFriendlyName);
             }
         }
 
@@ -77,7 +99,7 @@ void Update()
 
                 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/Utilities/Scripts/WorldAnchorManager.cs

@@ -23,8 +23,8 @@ public class WorldAnchorManager : Singleton<WorldAnchorManager>
         /// </summary>
         private struct AnchorAttachmentInfo
         {
-            public GameObject gameObjectToAnchor { get; set; }
-            public string anchorName { get; set; }
+            public GameObject GameObjectToAnchor { get; set; }
+            public string AnchorName { get; set; }
         }
 
         /// <summary>
@@ -36,23 +36,23 @@ private struct AnchorAttachmentInfo
         /// The WorldAnchorStore for the current application.  
         /// Can be null when the application starts.
         /// </summary>
-        public WorldAnchorStore anchorStore { get; set; }
+        public WorldAnchorStore AnchorStore { get; private set; }
 
         /// <summary>
         /// Callback function that contains the WorldAnchorStore object.
         /// </summary>
         /// <param name="Store">The WorldAnchorStore to cache.</param>
         void AnchorStoreReady(WorldAnchorStore Store)
         {
-            anchorStore = Store;
+            AnchorStore = Store;
         }
 
         /// <summary>
         /// When the app starts grab the anchor store immediately.
         /// </summary>
         void Awake()
         {
-            anchorStore = null;
+            AnchorStore = null;
             WorldAnchorStore.GetAsync(AnchorStoreReady);
         }
 
@@ -61,7 +61,7 @@ void Awake()
         /// </summary>
         void Update()
         {
-            if (anchorStore != null && anchorOperations.Count > 0)
+            if (AnchorStore != null && anchorOperations.Count > 0)
             {
                 DoAnchorOperation(anchorOperations.Dequeue());
             }
@@ -73,16 +73,16 @@ void Update()
         /// a new anchor will be saved under the specified name.
         /// </summary>
         /// <param name="gameObjectToAnchor">The Gameobject to attach the anchor to.</param>
-        /// <param name="AnchorName">Name of the anchor.</param>
-        public void AttachAnchor(GameObject gameObjectToAnchor, string AnchorName)
+        /// <param name="anchorName">Name of the anchor.</param>
+        public void AttachAnchor(GameObject gameObjectToAnchor, string anchorName)
         {
             if (gameObjectToAnchor == null)
             {
                 Debug.LogError("Must pass in a valid gameObject");
                 return;
             }
 
-            if (string.IsNullOrEmpty(AnchorName))
+            if (string.IsNullOrEmpty(anchorName))
             {
                 Debug.LogError("Must supply an AnchorName.");
                 return;
@@ -91,8 +91,8 @@ public void AttachAnchor(GameObject gameObjectToAnchor, string AnchorName)
             anchorOperations.Enqueue(
                 new AnchorAttachmentInfo()
                 {
-                    gameObjectToAnchor = gameObjectToAnchor,
-                    anchorName = AnchorName
+                    GameObjectToAnchor = gameObjectToAnchor,
+                    AnchorName = anchorName
                 }
                 );
         }
@@ -105,7 +105,7 @@ public void AttachAnchor(GameObject gameObjectToAnchor, string AnchorName)
         public void RemoveAnchor(GameObject gameObjectToUnanchor)
         {
             // This case is unexpected, but just in case.
-            if (anchorStore == null)
+            if (AnchorStore == null)
             {
                 Debug.LogError("remove anchor called before anchor store is ready.");
             }
@@ -114,7 +114,7 @@ public void RemoveAnchor(GameObject gameObjectToUnanchor)
 
             if (anchor != null)
             {
-                anchorStore.Delete(anchor.name);
+                AnchorStore.Delete(anchor.name);
                 DestroyImmediate(anchor);
             }
         }
@@ -125,8 +125,8 @@ public void RemoveAnchor(GameObject gameObjectToUnanchor)
         /// <param name="anchorAttachmentInfo">Parameters for attaching the anchor.</param>
         void DoAnchorOperation(AnchorAttachmentInfo anchorAttachmentInfo)
         {
-            string AnchorName = anchorAttachmentInfo.anchorName;
-            GameObject gameObjectToAnchor = anchorAttachmentInfo.gameObjectToAnchor;
+            string AnchorName = anchorAttachmentInfo.AnchorName;
+            GameObject gameObjectToAnchor = anchorAttachmentInfo.GameObjectToAnchor;
 
             if (gameObjectToAnchor == null)
             {
@@ -135,7 +135,7 @@ void DoAnchorOperation(AnchorAttachmentInfo anchorAttachmentInfo)
             }
 
             // Try to load a previously saved world anchor.
-            WorldAnchor savedAnchor = anchorStore.Load(AnchorName, gameObjectToAnchor);
+            WorldAnchor savedAnchor = AnchorStore.Load(AnchorName, gameObjectToAnchor);
             if (savedAnchor == null)
             {
                 // Either world anchor was not saved / does not exist or has a different name.
@@ -203,7 +203,7 @@ private void Anchor_OnTrackingChanged(WorldAnchor self, bool located)
         private void SaveAnchor(WorldAnchor anchor)
         {
             // Save the anchor to persist holograms across sessions.
-            if (anchorStore.Save(anchor.name, anchor))
+            if (AnchorStore.Save(anchor.name, anchor))
             {
                 Debug.Log(gameObject.name + " : World anchor saved successfully.");
             }