Merge pull request #234 from HodgsonSDAS/GazeManager-Update

Gaze manager update

Author: NeerajW

Assets/HoloToolkit/Input/Scripts/GazeManager.cs

@@ -2,7 +2,6 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using UnityEngine;
-using UnityEngine.VR.WSA;
 
 namespace HoloToolkit.Unity
 {
@@ -11,20 +10,51 @@ namespace HoloToolkit.Unity
     /// </summary>
     public partial class GazeManager : Singleton<GazeManager>
     {
+        /// <summary>
+        /// Maximum gaze distance, in meters, for calculating a hit from a GameOjects Collider.
+        /// </summary>
         [Tooltip("Maximum gaze distance, in meters, for calculating a hit.")]
         public float MaxGazeDistance = 15.0f;
 
+        /// <summary>
+        /// Select the layers raycast should target.
+        /// </summary>
         [Tooltip("Select the layers raycast should target.")]
         public LayerMask RaycastLayerMask = Physics.DefaultRaycastLayers;
 
+        /// <summary>
+        /// Checking enables SetFocusPointForFrame to set the stabilization plane.
+        /// </summary>
+        [Tooltip( "Checking enables SetFocusPointForFrame to set the stabilization plane." )]
+        public bool SetStabilizationPlane = true;
+
+        /// <summary>
+        /// Lerp speed when moving focus point closer.
+        /// </summary>
+        [Tooltip( "Lerp speed when moving focus point closer." )]
+        public float LerpStabilizationPlanePowerCloser = 4.0f;
+
+        /// <summary>
+        /// Lerp speed when moving focus point farther away.
+        /// </summary>
+        [Tooltip( "Lerp speed when moving focus point farther away." )]
+        public float LerpStabilizationPlanePowerFarther = 7.0f;
+
+        /// <summary>
+        /// Use built in gaze stabilization that utilizes gavity wells.
+        /// Change to false if you wish to use your own gabilization calculation
+        /// and extend this class.
+        /// </summary>
+        [Tooltip("Use built in gaze stabilization that utilizes gavity wells.")]
+        public bool UseBuiltInGazeStabilization = true;
+
         /// <summary>
         /// Physics.Raycast result is true if it hits a hologram.
         /// </summary>
         public bool Hit { get; private set; }
 
         /// <summary>
-        /// HitInfo property gives access
-        /// to RaycastHit public members.
+        /// HitInfo property gives access to RaycastHit public members.
         /// </summary>
         public RaycastHit HitInfo { get; private set; }
 
@@ -43,21 +73,35 @@ public partial class GazeManager : Singleton<GazeManager>
         /// </summary>
         public GameObject FocusedObject { get; private set; }
 
-        [Tooltip("Checking enables SetFocusPointForFrame to set the stabilization plane.")]
-        public bool SetStabilizationPlane = true;
-        [Tooltip("Lerp speed when moving focus point closer.")]
-        public float LerpStabilizationPlanePowerCloser = 4.0f;
-        [Tooltip("Lerp speed when moving focus point farther away.")]
-        public float LerpStabilizationPlanePowerFarther = 7.0f;
+        /// <summary>
+        /// Helper class that stabilizes gaze using gravity wells
+        /// </summary>
+        public GazeStabilizer GazeStabilization { get; private set; }
 
         private Vector3 gazeOrigin;
         private Vector3 gazeDirection;
+        private Quaternion gazeRotation;
         private float lastHitDistance = 15.0f;
 
+        private void Awake()
+        {
+            if (UseBuiltInGazeStabilization)
+            {
+                GazeStabilization = gameObject.GetComponent<GazeStabilizer>() ??
+                                    gameObject.AddComponent<GazeStabilizer>();
+            }
+        }
+
         private void Update()
         {
             gazeOrigin = Camera.main.transform.position;
             gazeDirection = Camera.main.transform.forward;
+            gazeRotation = Camera.main.transform.rotation;
+
+            if (GazeStabilization != null)
+            {
+                GazeStabilization.UpdateHeadStability(gazeOrigin, gazeRotation);
+            }
 
             UpdateRaycast();
             UpdateStabilizationPlane();
@@ -70,13 +114,18 @@ private void UpdateRaycast()
         {
             // Get the raycast hit information from Unity's physics system.
             RaycastHit hitInfo;
-            Hit = Physics.Raycast(gazeOrigin,
-                           gazeDirection,
-                           out hitInfo,
-                           MaxGazeDistance,
-                           RaycastLayerMask);
+
+            if (GazeStabilization != null)
+            {
+                Hit = Physics.Raycast(GazeStabilization.StableHeadRay, out hitInfo, MaxGazeDistance, RaycastLayerMask);
+            }
+            else
+            {
+                Hit = Physics.Raycast(gazeOrigin, gazeDirection, out hitInfo, MaxGazeDistance, RaycastLayerMask);
+            }
 
             GameObject oldFocusedObject = FocusedObject;
+
             // Update the HitInfo property so other classes can use this hit information.
             HitInfo = hitInfo;
 
@@ -127,7 +176,7 @@ private void UpdateStabilizationPlane()
                 }
             }
 
-            if (StabilizationPlaneModifier.Instance)
+            if (StabilizationPlaneModifier.Instance != null)
             {
                 StabilizationPlaneModifier.Instance.SetStabilizationPlane = SetStabilizationPlane;
             }