Using get/set to change the observed volume

Author: EMEA\vonhorc

Assets/HoloToolkit/SpatialMapping/Scripts/SpatialMappingObserver.cs

@@ -24,6 +24,28 @@ public enum ObserverStates
         Stopped = 1
     }
 
+	/// <summary>
+	/// Spatial Mapping Volume Type
+	/// </summary>
+	public enum ObserverVolumeTypes
+	{
+		/// <summary>
+		/// The observed volume is an axis aligned box.
+		/// </summary>
+		AxisAlignedBox = 0,
+		
+		/// <summary>
+		/// The observed volume is an oriented box.
+		/// </summary>
+		OrientedBox = 1,
+		
+		/// <summary>
+		/// The observed volume is a sphere.
+		/// </summary>
+		Sphere = 2
+	}
+	
+	
     /// <summary>
     /// The SpatialMappingObserver class encapsulates the SurfaceObserver into an easy to use
     /// object that handles managing the observed surfaces and the rendering of surface geometry.
@@ -32,22 +54,34 @@ public class SpatialMappingObserver : SpatialMappingSource
     {
         [Tooltip("The number of triangles to calculate per cubic meter.")]
         public float TrianglesPerCubicMeter = 500f;
-
-        [Tooltip("The extents of the observation volume.")]
-        public Vector3 Extents = Vector3.one * 10.0f;
-
+		
         [Tooltip("How long to wait (in sec) between Spatial Mapping updates.")]
         public float TimeBetweenUpdates = 3.5f;
 
-        /// <summary>
-        /// The origin of the observation volume.
-        /// </summary>
-        private Vector3 origin = Vector3.zero;
-
         /// <summary>
         /// Indicates the current state of the Surface Observer.
         /// </summary>
         public ObserverStates ObserverState { get; private set; }
+		
+		/// <summary>
+		/// Indicates the current type of the observed volume
+		/// </summary>
+		private ObserverVolumeTypes observerVolumeType = ObserverVolumeTypes.AxisAlignedBox;
+		public ObserverVolumeTypes ObserverVolumeType
+		{
+			get
+			{
+				return observerVolumeType;
+			}
+			set
+			{
+				if(observerVolumeType != value)
+				{
+					observerVolumeType = value;
+					SwitchObservedVolume();
+				}
+			}
+		}
 
         /// <summary>
         /// Our Surface Observer object for generating/updating Spatial Mapping data.
@@ -77,7 +111,69 @@ public class SpatialMappingObserver : SpatialMappingSource
         /// Used to track when the Observer was last updated.
         /// </summary>
         private float updateTime;
-
+		
+		[Tooltip("The extents of the observation volume.")]
+        private Vector3 extents = Vector3.one * 10.0f;
+        public Vector3 Extents
+        {
+            get
+            {
+                return extents;
+            }
+            set
+            {
+				if(extents != value)
+				{
+					extents = value;
+					SwitchObservedVolume();
+				}
+            }
+        }
+		
+        /// <summary>
+        /// The origin of the observation volume.
+        /// </summary>
+        private Vector3 origin = Vector3.zero;
+		public Vector3 Origin
+		{
+			get
+			{
+				return origin;
+			}
+			set
+			{
+				if(origin != value)
+				{
+					origin = value;
+					SwitchObservedVolume();
+				}
+			}
+		}
+		
+		/// <summary>
+		/// The direction of the observed volume if an oriented box is choosen.
+		/// </summary>
+		private Quaternion orientation = Quaternion.identity;
+		public Quaternion Orientation
+		{
+			get
+			{
+				return orientation;
+			}
+			set
+			{
+				if(orientation != value)
+				{
+					orientation = value;
+					// Only needs to be changed if the corresponding mode is active.
+					if(ObserverVolumeType == ObserverVolumeTypes.OrientedBox)
+					{	
+						SwitchObservedVolume();
+					}
+				}
+			}
+		}
+		
         protected override void Awake()
         {
             base.Awake();
@@ -171,7 +267,7 @@ public void StartObserving()
             if (observer == null)
             {
                 observer = new SurfaceObserver();
-                observer.SetVolumeAsAxisAlignedBox(Vector3.zero, Extents);
+                SwitchObservedVolume();
             }
 
             if (ObserverState != ObserverStates.Running)
@@ -230,48 +326,45 @@ public void CleanupObserver()
 
         /// <summary>
         /// Can be called to override the default origin for the observed volume.  Can only be called while observer has been started.
+		/// Kept for compatibility with Examples/SpatialUnderstanding
         /// </summary>
-        public bool SetObserverOrigin(Vector3 origin)
+        public bool SetObserverOrigin(Vector3 _origin)
         {
             bool originUpdated = false;
 
             if (observer != null)
             {
-                observer.SetVolumeAsAxisAlignedBox(origin, Extents);
+                Origin = _origin;
                 originUpdated = true;
             }
 
             return originUpdated;
         }
 
-        /// <summary>
-        /// Can be called to override the default extents as an axis aligned box for the observed volume. Can only be called while observer has been started.
-        /// </summary>
-        public bool SetObserverExtentsAxisAligned(Vector3 extents)
-        {
-            bool extentsUpdated = false;
-            if (observer != null)
-            {
-                observer.SetVolumeAsAxisAlignedBox(origin, extents);
-                Extents = extents;
-                extentsUpdated = true;
-            }
-            return extentsUpdated;
-        }
-
-        /// <summary>
-        /// Can be called to override the default extents as an oriented box for the observed volume. Can only be called while observer has been started.
-        /// </summary>
-        public bool SetObserverExtentsOrientedBox(Vector3 extents, Quaternion orientation)
-        {
-            bool extentsUpdated = false;
-            if (observer != null)
-            {
-                observer.SetVolumeAsOrientedBox(origin, extents, orientation);
-                extentsUpdated = true;
-            }
-            return extentsUpdated;
-        }
+		/// <summary>
+		/// Change the observed volume according to ObserverVolumeType.
+		/// </summary>
+		private void SwitchObservedVolume()
+		{
+			if (observer != null)
+			{
+                switch (observerVolumeType)
+                {
+                    case ObserverVolumeTypes.AxisAlignedBox:
+                        observer.SetVolumeAsAxisAlignedBox(origin, extents);
+                        break;
+                    case ObserverVolumeTypes.OrientedBox:
+                        observer.SetVolumeAsOrientedBox(origin, extents, orientation);
+                        break;
+                    case ObserverVolumeTypes.Sphere:
+                        observer.SetVolumeAsSphere(origin, extents.magnitude); //workaround
+                        break;
+                    default:
+                        observer.SetVolumeAsAxisAlignedBox(origin, extents);
+                        break;
+                }
+			}
+		}
 
         /// <summary>
         /// Handles the SurfaceObserver's OnDataReady event.