Merge pull request #2 from arnebp/master

Release 1.1.0.0

Author: arnebp

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log #
 ---
 
+Version 1.1.0.0 (2016-09-26)
+---
+
+- Scene flow and interaction improvements
+- Project Restructuring for easier export/import
+- New key input mapping
+- Updated EyeTribe C# SDK dependency to v.0.9.77.5
+
 Version 1.0.0.1 (2016-06-07)
 ---
 

README.md

@@ -8,7 +8,7 @@ This is a collection of tools and utilities for  [EyeTribe Dev Kit](https://thee
 
 An [EyeTribe Tracker](https://theeyetribe.com/products/)  or [EyeTribe VR Tracker](https://theeyetribe.com/wp-content/uploads/2016/01/vr-product-sheet.pdf) is required to use this library. This dev kit supports both ***remote eye-tracking*** and ***vr eye-tracking***.
 
-Developed for and tested against [Unity 5.4b20](https://unity3d.com/unity/beta). **Note:** This is a Unity **BETA** version.
+Developed for and tested against [Unity 5.4.1](https://store.unity.com/download?ref=update).
 
 Prerequisites
 ----
@@ -39,33 +39,35 @@ Build for desired target platform using Unity Build Settings.
 
 Keyboard:
 
+- Fire1: Left Ctrl
+- Fire2: Left Alt
+- Fire3: Left Shift
+- Fire4: Space
 - Esc: Exit app
 - 1: Show/Hide GazeIndicator
 - 2: Toggle raw/smooth gaze data
-- 3: Show/Hide debug output
+- 3: Show/Hide Gaze Info
 - 4: Show/Hide CalibrationArea
 - 5: Reduce CalibrationArea Width
 - 6: Increase CalibrationArea Width
 - 7: Reduce CalibrationArea Height
 - 8: Increase CalibrationArea Height
-- Space: Start Calibration
-- Return/enter: Start next scene (if calibrated)
-- Control/Command: Select (interaction scene)
 
 GamePad:
 
-- Fire1/X: Start Calibration *or* Select (interaction scene)
-- Fire2/Y: Start next scene (if calibrated)
-- Fire3/A: Show/Hide GazeIndicator
-- Fire4/B: Show/Hide debug output
-- Back: Go one scene back or exit
+- Fire1: X Button
+- Fire2: Y Button
+- Fire3: A Button, Show/Hide GazeIndicator
+- Fire4: B Button, Show/Hide Gaze Info
+- Back: Go Back or Exit
 
 GearVR Touchpad:
 
-- Back: Go one scene back or exit
-- Horizontal Swipe: Start Start Calibration
-- Vertical Swipe: Show/Hide debug output
-- Tap: Start next scene (if calibrated) *or* Select (interaction scene)
+- Fire1: Tap
+- Fire2: Swipe Down
+- Fire3: Swipe Back, Show/Hide GazeIndicator
+- Fire4: Double-Tap, Show/Hide Gaze Info
+- Back: Go Back or Exit
 
 
 Unity-Commons
@@ -79,7 +81,7 @@ Find the latest ***EyeTribe.Unity.dll*** under [releases](https://github.com/Eye
 
 Should you choose extend this library and build it yourself, the project needs to know your Unity installation path. To set this up, open the project file *'./unity-commons/commons/unity-commons.csproj'* with a text editor. Then modify the property *$(YourUnityFolder)* to the path of your Unity installation.
 
-    <YourUnityFolder>C:\Program Files\Unity 5.4b20\</YourUnityFolder>
+    <YourUnityFolder>C:\Program Files\Unity\</YourUnityFolder>
 
 Open the project in [Visual Studio Express 2013](https://www.microsoft.com/en-us/download/details.aspx?id=44914) or similar and build. Note that [.Net Framwork 3.5 SP1](https://www.microsoft.com/en-us/download/details.aspx?id=22) is a requirement to build a Unity supported library.
 

unity-commons/commons/packages.config

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="EyeTribe.ClientSdk" version="0.9.77.2" targetFramework="net35" />
+  <package id="EyeTribe.ClientSdk" version="0.9.77.5" targetFramework="net35" />
   <package id="ILRepack.MSBuild.Task" version="1.0.9" targetFramework="net35" />
-  <package id="Newtonsoft.Json" version="8.0.3" targetFramework="net35" />
+  <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net35" />
   <package id="TaskParallelLibrary" version="1.0.2856.0" targetFramework="net35" />
 </packages>

unity-commons/commons/scripts/CanvasUtils.cs

@@ -13,26 +13,7 @@
 namespace EyeTribe.Unity
 { 
     public class CanvasUtils
-    {
-        public static void SetRendererEnabled(RectTransform rt, bool isEnabled)
-        {
-            if (null != rt)
-            {
-                UIBehaviour[] uis = rt.GetComponentsInChildren<UIBehaviour>();
-                foreach (UIBehaviour uib in uis)
-                {
-                    uib.enabled = isEnabled;
-                }
-            }
-        }
-
-        public static bool IsRendererEnabled(RectTransform rt)
-        {
-            if (null != rt)
-                return rt.GetComponent<UIBehaviour>().enabled;
-            return false;
-        }
-
+    {     
         public static RectTransform GetUiComponentFromTag(Canvas canvas, String tag)
         {
             RectTransform[] components = canvas.GetComponentsInChildren<RectTransform>();

unity-commons/commons/scripts/ExtensionMethods.cs

@@ -123,6 +123,21 @@ public static Vector3 ToVec3(this Point2D gp)
         return new Vector3((float)gp.X, (float)gp.Y, 0f);
     }
 
+    public static Vector3 GetWorldPositionFromGaze(this Point2D gp, Camera cam, float depth)
+    {
+        if (null != cam)
+        {
+            return cam.ScreenToWorldPoint(
+                new Vector3(
+                    (float)gp.X,
+                    (float)(cam.pixelHeight - gp.Y),
+                    depth)
+                    );
+        }
+
+        return Vector3.zero;
+    }
+
     #endregion
 
     #region Point3D Extensions
@@ -263,11 +278,27 @@ public static RectTransform GetChildRectTransformFromTag(this Canvas canvas, str
 
     #region Camera Extensions
 
+    /// <summary>
+    /// Find the bounds of the Camera viewport in Unity units (meters) at a desired distance.
+    /// </summary>
+    /// <param name="depth"/>distance from camera to use</param>
+    /// <returns>Unity Vector2</returns>
     public static Vector2 GetPerspectiveWorldScreenBounds(this Camera camera, float depth)
+    {
+        return GetPerspectiveDegreeBounds(camera, camera.fieldOfView, depth);
+    }
+
+    /// <summary>
+    /// Find the bounds of custom Camera viewport in Unity units (meters) at a desired distance.
+    /// </summary>
+    /// <param name="degrees"/>width of custom fov in degrees</param>
+    /// <param name="depth"/>distance from camera to use</param>
+    /// <returns>Unity Vector2</returns>
+    public static Vector2 GetPerspectiveDegreeBounds(this Camera camera, float degrees, float depth)
     {
         Vector3 position = camera.transform.position + camera.transform.forward * depth;
 
-        float h = Mathf.Tan(camera.fieldOfView * Mathf.Deg2Rad * 0.5f) * depth * 2f;
+        float h = Mathf.Tan(degrees * Mathf.Deg2Rad * 0.5f) * depth * 2f;
 
         return new Vector2(h * camera.aspect, h);
     }

unity-commons/commons/scripts/EyeTribeSDK.cs

@@ -19,16 +19,20 @@
 
 namespace EyeTribe.Unity
 {
-    public class EyeTribeSDK : MonoBehaviour, IGazeListener, IConnectionStateListener, ITrackerStateListener, ICalibrationResultListener
+    public class EyeTribeSDK : MonoBehaviour, IGazeListener, IConnectionStateListener, ITrackerStateListener, 
+        ICalibrationResultListener, ICalibrationStateListener
     {
         public static event Action<bool> OnConnectionStateChange;
         public static event Action<GazeManager.TrackerState> OnTrackerStateChange;
-        public static event Action<bool, CalibrationResult> OnCalibration;
+        public static event Action<bool, CalibrationResult> OnCalibrationResult;
+        public static event Action<bool, bool> OnCalibrationStateChange;
 
         [SerializeField]private UnityDispatcher _Dispatcher;
 
         private const string DEFAULT_CFG = "network.cfg";
 
+        private IEnumerator _FrameCacheUpdater;
+
         void Awake() 
         {
             if (null == _Dispatcher)
@@ -42,6 +46,7 @@ void OnEnable()
             GazeManager.Instance.AddTrackerStateListener(this);
             GazeManager.Instance.AddCalibrationResultListener(this);
             GazeManager.Instance.AddConnectionStateListener(this);
+            GazeManager.Instance.AddCalibrationStateListener(this);
 
             //activate EyeTribe C# SDK, default port
             if (!GazeManager.Instance.IsActivated)
@@ -62,21 +67,27 @@ void OnEnable()
                         GazeManager.Instance.ActivateAsync(GazeManager.ApiVersion.VERSION_1_0, ip, 6555);
                     }
                 }
+
+            StartCoroutine(_FrameCacheUpdater = BalancedUpdater());
         }
 
         void OnDisable()
         {
+            if (null != _FrameCacheUpdater)
+                StopCoroutine(_FrameCacheUpdater);
+
             //deregister listeners
             GazeManager.Instance.RemoveGazeListener(this);
             GazeManager.Instance.RemoveTrackerStateListener(this);
             GazeManager.Instance.RemoveCalibrationResultListener(this);
             GazeManager.Instance.RemoveConnectionStateListener(this);
+            GazeManager.Instance.RemoveCalibrationStateListener(this);
         }
 
         public void OnGazeUpdate(GazeData gazeData)
         {
             //Add frame to GazeData cache handler
-            GazeFrameCache.Instance.Update(gazeData);
+            GazeFrameCache.Instance.Enqueue(gazeData);
         }
 
         void OnApplicationQuit()
@@ -106,11 +117,31 @@ public void OnCalibrationChanged(bool isCalibrated, CalibrationResult calibResul
         {
             _Dispatcher.Dispatch(() =>
             {
-                if (OnCalibration != null)
-                    OnCalibration(isCalibrated, calibResult);
+                if (OnCalibrationResult != null)
+                    OnCalibrationResult(isCalibrated, calibResult);
+            });
+        }
+
+
+        public void OnCalibrationStateChanged(bool isCalibrating, bool isCalibrated)
+        {
+            _Dispatcher.Dispatch(() =>
+            {
+                if (OnCalibrationStateChange != null)
+                    OnCalibrationStateChange(isCalibrating, isCalibrated);
             });
         }
 
+        private IEnumerator BalancedUpdater() 
+        {
+            while(enabled)
+            {
+                GazeFrameCache.Instance.Update();
+
+                yield return new WaitForSeconds(Time.smoothDeltaTime / 1f);
+            }
+        }
+
         public String GetExternalFilePath(string fileName)
         {
             String extPath = null;

unity-commons/commons/scripts/EyeTribeUnityScript.cs

@@ -29,7 +29,7 @@ public class EyeTribeUnityScript : MonoBehaviour, IGazeListener
         public virtual void Awake()
         {
             //turn off VR if no VR device present
-            _UsingVR = VRMode.IsRunningInVRMode();
+            _UsingVR = VRMode.IsRunningInVRMode;
         }
 
         public virtual void OnEnable()

unity-commons/commons/scripts/FrameRateGazeDataQueue.cs

@@ -23,18 +23,22 @@ namespace EyeTribe.Unity
     public class FrameRateGazeDataQueue : GazeDataQueue
     {
         private readonly static long BUFFER_SIZE_MILLIS = 5000;
-        private readonly static long BUFFER_SIZE_MIN = BUFFER_SIZE_MILLIS / 2;
 
         public FrameRateGazeDataQueue()
             : base(BUFFER_SIZE_MILLIS)
         {
         }
+        
+        public FrameRateGazeDataQueue(long timeLimit)
+            : base(timeLimit)
+        {
+        }
 
         public float GetAvgFramesPerSecond()
         {
             float avgMillis;
             if ((avgMillis = GetAvgMillisFrame()) > 0)
-                return 1000 / avgMillis;
+                return 1000f / avgMillis;
 
             return -1;
         }
@@ -51,12 +55,12 @@ public float GetAvgMillisFrame()
                     float delta = last.TimeStamp - first.TimeStamp;
 
                     // only return value when buffer populated
-                    if (delta > BUFFER_SIZE_MIN)
+                    if (delta > (TimeLimit >> 1))
                         return delta / this.Count();
                 }
             }
 
-            return 0f;
+            return -1;
         }
     }
 }

unity-commons/commons/scripts/GazeFPS.cs

@@ -46,6 +46,5 @@ public float AvgFPS
                 return 0f;
             }
         }
-
      }
 }