Merge branch 'mwarb-improved-trackers' into master

Author: jackbrookes

Assets/UXF/Examples/4_CorsiBlock/CorsiBlockExample.unity

@@ -2348,6 +2348,11 @@ PrefabInstance:
       propertyPath: settingsToLog.Array.size
       value: 1
       objectReference: {fileID: 0}
+    - target: {fileID: 114916036141644208, guid: 0a3b6392f04558844bd340e68ced1ff9,
+        type: 3}
+      propertyPath: trackedObjects.Array.size
+      value: 1
+      objectReference: {fileID: 0}
     - target: {fileID: 114916036141644208, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 3}
       propertyPath: onSessionBegin.m_PersistentCalls.m_Calls.Array.data[0].m_Mode
@@ -2593,6 +2598,11 @@ PrefabInstance:
       propertyPath: storeSessionSettings
       value: 0
       objectReference: {fileID: 0}
+    - target: {fileID: 114916036141644208, guid: 0a3b6392f04558844bd340e68ced1ff9,
+        type: 3}
+      propertyPath: trackedObjects.Array.data[0]
+      value: 
+      objectReference: {fileID: 0}
     - target: {fileID: 203569540471596912, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 3}
       propertyPath: m_Value
@@ -2856,7 +2866,7 @@ PrefabInstance:
     - target: {fileID: 2834388984357925155, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 3}
       propertyPath: m_AnchoredPosition.y
-      value: 2080
+      value: 4225
       objectReference: {fileID: 0}
     - target: {fileID: 2896031059644693069, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 3}
@@ -2946,7 +2956,7 @@ PrefabInstance:
     - target: {fileID: 4267567203292169432, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 3}
       propertyPath: m_AnchoredPosition.y
-      value: 3840
+      value: 7800
       objectReference: {fileID: 0}
     - target: {fileID: 4298776666381973480, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 3}
@@ -4836,6 +4846,7 @@ GameObject:
   m_Component:
   - component: {fileID: 1513556399}
   - component: {fileID: 1513556400}
+  - component: {fileID: 1513556401}
   m_Layer: 0
   m_Name: CorsiBlockTask
   m_TagString: Untagged
@@ -4898,6 +4909,27 @@ MonoBehaviour:
   - {fileID: 1622668012}
   randomOffsetMax: {x: 0.5, y: 0.5}
   feedback: {fileID: 448119297}
+--- !u!114 &1513556401
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1513556398}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 7e116bc94825b784182983179cfbb420, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  objectName: corsiblocktask
+  measurementDescriptor: mouse_position
+  customHeader:
+  - pos_x
+  - pos_y
+  - pos_z
+  updateType: 0
+  distanceFromCamera: 25
+  mainCamera: {fileID: 33142922}
 --- !u!1 &1574932393
 GameObject:
   m_ObjectHideFlags: 0

Assets/UXF/Scripts/Etc/Tracker.cs

@@ -41,6 +41,8 @@ public string dataName
 
         private bool recording;
 
+        public bool Recording { get { return recording; } }
+
         public UXFDataTable data { get; private set; } = new UXFDataTable();
 
         /// <summary>
@@ -56,7 +58,13 @@ public string[] header
                 customHeader.CopyTo(newHeader, 1);
                 return newHeader;
             }
-        } 
+        }
+
+        /// <summary>
+        /// When the tracker should take measurements.
+        /// </summary>
+        [Tooltip("When the measurements should be taken.\n\nManual should only be selected if the user is calling the RecordRow method either from another script or a custom Tracker class.")]
+        public TrackerUpdateType updateType = TrackerUpdateType.LateUpdate;
 
         // called when component is added
         void Reset()
@@ -68,20 +76,27 @@ void Reset()
         // called by unity just before rendering the frame
         void LateUpdate()
         {
-            if (recording) RecordRow();
+            if (recording && updateType == TrackerUpdateType.LateUpdate) RecordRow();
+        }
+
+        // called by unity when physics simulations are run
+        void FixedUpdate()
+        {
+            if (recording && updateType == TrackerUpdateType.FixedUpdate) RecordRow();
         }
 
         /// <summary>
         /// Records a new row of data at current time.
         /// </summary>
         public void RecordRow()
         {
+            if (!recording) throw new System.InvalidOperationException("Tracker measurements cannot be taken when not in a trial!");
+            
             UXFDataRow newRow = GetCurrentValues();
             newRow.Add(("time", Time.time));
             data.AddCompleteRow(newRow);
         }
 
-
         /// <summary>
         /// Begins recording.
         /// </summary>
@@ -91,14 +106,6 @@ public void StartRecording()
             recording = true;
         }
 
-        /// <summary>
-        /// Pauses recording.
-        /// </summary>
-        public void PauseRecording()
-        {
-            recording = false;
-        }
-
         /// <summary>
         /// Stops recording.
         /// </summary>
@@ -119,4 +126,12 @@ public void StopRecording()
         protected abstract void SetupDescriptorAndHeader();
 
     }
+
+    /// <summary>
+    /// When the tracker should collect new measurements. Manual should only be selected if the user is calling the RecordRow method either from another script or a custom Tracker class.
+    /// </summary>
+    public enum TrackerUpdateType
+    {
+        LateUpdate, FixedUpdate, Manual
+    }
 }

Assets/UXF/Scripts/Etc/Tracker.cs.meta

@@ -95,7 +95,14 @@ public void Begin()
 
             foreach (Tracker tracker in session.trackedObjects)
             {
-                tracker.StartRecording();
+                try
+                {
+                    tracker.StartRecording();
+                }
+                catch (NullReferenceException)
+                {
+                    Debug.LogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
+                }
             }
             session.onTrialBegin.Invoke(this);
         }
@@ -107,12 +114,29 @@ public void End()
         {
             status = TrialStatus.Done;
             endTime = Time.time;
-            result["end_time"] = endTime;            
+            result["end_time"] = endTime;
+
+            // check no duplicate trackers
+            List<string> duplicateTrackers = session.trackedObjects.Where(tracker => tracker != null)
+              .GroupBy(tracker => tracker.dataName)
+              .Where(g => g.Count() > 1)
+              .Select(y => y.Key)
+              .ToList(); 
+
+            if (duplicateTrackers.Any()) throw new InvalidOperationException(string.Format("Two or more trackers in the Tracked Objects field in the Session Inspector have the following object name and descriptor pair, please change the object name fields on the trackers to make them unique: {0}", string.Join(",", duplicateTrackers)));
 
             // log tracked objects
             foreach (Tracker tracker in session.trackedObjects)
             {
-                SaveDataTable(tracker.data, tracker.dataName, dataType: UXFDataType.Trackers);
+                try
+                {
+                    tracker.StopRecording();
+                    SaveDataTable(tracker.data, tracker.dataName, dataType: UXFDataType.Trackers);
+                }
+                catch (NullReferenceException)
+                {
+                    Debug.LogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
+                }
             }
 
             // log any settings we need to for this trial

Assets/UXF/Scripts/Etc/Trial.cs

@@ -0,0 +1,46 @@
+using UnityEngine;
+
+namespace UXF
+{
+    /// <summary>
+    /// Attach this component to any gameobject and assign it in the trackedObjects field in an ExperimentSession to automatically record the position of the mouse in screen coordinates. 
+    /// Note (0, 0) is the bottom-left of the window displaying the game.
+    /// </summary>
+    public class MouseScreenTracker : Tracker
+    {
+        /// <summary>
+        /// Sets measurementDescriptor and customHeader to appropriate values
+        /// </summary>
+        protected override void SetupDescriptorAndHeader()
+        {
+            measurementDescriptor = "mouse_screen";
+            
+            customHeader = new string[]
+            {
+                "pix_x",
+                "pix_y"
+            };
+        }
+
+        /// <summary>
+        /// Returns current mouse position in screen coordinates
+        /// </summary>
+        /// <returns></returns>
+        protected override UXFDataRow GetCurrentValues()
+        {
+            // get position and rotation
+            Vector2 p = new Vector2(Input.mousePosition.x, Input.mousePosition.y);
+
+            string format = "0";
+
+            // return position, rotation (x, y, z) as an array
+            var values = new UXFDataRow()
+            {
+                ("pix_x", p.x.ToString(format)),
+                ("pix_y", p.y.ToString(format))
+            };
+
+            return values;
+        }
+    }
+}

Assets/UXF/Scripts/Trackers.meta

@@ -0,0 +1,53 @@
+using UnityEngine;
+
+namespace UXF
+{
+    /// <summary>
+    /// Attach this component to any gameobject and assign it in the trackedObjects field in an ExperimentSession to automatically record the position of the mouse in world coordinates.
+    /// </summary>
+    public class MouseWorldTracker : Tracker
+    {
+        [Tooltip("Distance from the camera plane to convert pixels to world point.\n\nFor perspective cameras this should be the distance from the camera to the plane you're interested in measuring.\n\nFor orthographic cameras this value shouldn't matter.")]
+        public float distanceFromCamera = 1f;
+
+        [Tooltip("Assign the main camera in the scene here.")]
+        public Camera mainCamera;
+
+        /// <summary>
+        /// Sets measurementDescriptor and customHeader to appropriate values
+        /// </summary>
+        protected override void SetupDescriptorAndHeader()
+        {
+            measurementDescriptor = "mouse_world";
+            
+            customHeader = new string[]
+            {
+                "pos_x",
+                "pos_y",
+                "pos_z",
+            };
+        }
+
+        /// <summary>
+        /// Returns current mouse position in world coordinates
+        /// </summary>
+        /// <returns></returns>
+        protected override UXFDataRow GetCurrentValues()
+        {
+            // get position and rotation
+            Vector3 p = mainCamera.ScreenToWorldPoint(new Vector3(Input.mousePosition.x, Input.mousePosition.y, distanceFromCamera));
+
+            string format = "0.####";
+
+            // return position, rotation (x, y, z) as an array
+            var values = new UXFDataRow()
+            {
+                ("pos_x", p.x.ToString(format)),
+                ("pos_y", p.y.ToString(format)),
+                ("pos_z", p.z.ToString(format))
+            };
+
+            return values;
+        }
+    }
+}