update Tracker system

Author: jackbrookes

Assets/UXF/Scripts/Etc/Editor/TrackerEditor.cs

@@ -4,16 +4,18 @@
 
 namespace UXF.EditorUtils
 {
-    [CustomEditor(typeof(UXF.Tracker), true)]
+    [CustomEditor(typeof(Tracker), true)]
     [CanEditMultipleObjects]
     public class TrackerEditor : Editor
     {
-        SerializedProperty customHeader, measurementDescriptor;
+        GUIStyle smallText = new GUIStyle();
+        Tracker thisTracker;
 
         void OnEnable()
         {
-            customHeader = serializedObject.FindProperty("customHeader");
-            measurementDescriptor = serializedObject.FindProperty("measurementDescriptor");
+            smallText.font = EditorStyles.miniFont;
+            smallText.fontSize = 9;
+            thisTracker = (Tracker)serializedObject.targetObject;
         }
 
         public override void OnInspectorGUI()
@@ -31,34 +33,38 @@ public override void OnInspectorGUI()
             {
                 if (field.IsPublic || field.GetCustomAttribute(typeof(SerializeField)) != null)
                 {                    
-                    if (field.Name != measurementDescriptor.name && field.Name != customHeader.name)
-                    {
-                        var prop = serializedObject.FindProperty(field.Name);
-                        EditorGUILayout.PropertyField(prop);
-                    }
+                    var prop = serializedObject.FindProperty(field.Name);
+                    EditorGUILayout.PropertyField(prop);
                 }
             }
 
             EditorGUILayout.Space();
-            GUI.enabled = false;
 
-            EditorGUILayout.LabelField(customHeader.displayName);
+            EditorGUILayout.LabelField("Custom Header");
+            EditorGUILayout.TextField("(\"time\" is added automatically)", smallText);
             EditorGUI.indentLevel += 1;
-
-            foreach (SerializedProperty element in customHeader)
-            {
-                EditorGUILayout.TextField(element.stringValue);
-            }
+            GUI.enabled = false;
+            EditorGUILayout.TextField(string.Join(", ", thisTracker.CustomHeader));
+            GUI.enabled = true;
             EditorGUI.indentLevel -= 1;
 
             EditorGUILayout.Space();
 
-            EditorGUILayout.LabelField(measurementDescriptor.displayName);
+            EditorGUILayout.LabelField("Measurement Descriptor");
             EditorGUI.indentLevel += 1;
-            EditorGUILayout.TextField(measurementDescriptor.stringValue);
+            GUI.enabled = false;
+            EditorGUILayout.TextField(thisTracker.MeasurementDescriptor);
+            GUI.enabled = true;
             EditorGUI.indentLevel -= 1;
 
+            EditorGUILayout.Space();
+            EditorGUILayout.LabelField("Example Filename");
+            EditorGUI.indentLevel += 1;
+            GUI.enabled = false;
+            EditorGUILayout.TextField(string.Format("{0}_T001.csv", thisTracker.DataName));
             GUI.enabled = true;
+            EditorGUI.indentLevel -= 1;
+
             serializedObject.ApplyModifiedProperties();
         }
     }

Assets/UXF/Scripts/Etc/Tracker.cs

@@ -2,6 +2,7 @@
 using System.Collections;
 using System.IO;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace UXF
 {
@@ -10,6 +11,9 @@ namespace UXF
     /// </summary>
     public abstract class Tracker : MonoBehaviour
     {
+        private bool recording = false;
+        private static string[] baseHeaders = new string[] { "time" };
+
         /// <summary>
         /// Name of the object used in saving
         /// </summary>
@@ -18,47 +22,29 @@ public abstract class Tracker : MonoBehaviour
         /// <summary>
         /// Description of the type of measurement this tracker will perform.
         /// </summary>
-        [Tooltip("Description of the type of measurement this tracker will perform.")]
-        public string measurementDescriptor;
+        public abstract string MeasurementDescriptor { get; }  
 
         /// <summary>
-        /// Custom column headers for tracked objects. Time is added automatically
+        /// Custom column headers for tracked objects.
         /// </summary>
-        [Tooltip("Custom column headers for each measurement.")]
-        public string[] customHeader = new string[] { };
+        public abstract IEnumerable<string> CustomHeader { get; }  
 
         /// <summary>
         /// A name used when saving the data from this tracker.
         /// </summary>
-        public string dataName
+        public string DataName
         {
             get
             {
-                Debug.AssertFormat(measurementDescriptor.Length > 0, "No measurement descriptor has been specified for this Tracker!");
-                return string.Join("_", new string[]{ objectName, measurementDescriptor });
+                Debug.AssertFormat(MeasurementDescriptor.Length > 0, "No measurement descriptor has been specified for this Tracker!");
+                return string.Join("_", new string[]{ objectName, MeasurementDescriptor });
             }
         }
 
-        private bool recording;
-
         public bool Recording { get { return recording; } }
 
-        public UXFDataTable data { get; private set; } = new UXFDataTable();
+        public UXFDataTable Data { get; private set; } = new UXFDataTable();
 
-        /// <summary>
-        /// The header that will go at the top of the output file associated with this tracker
-        /// </summary>
-        /// <returns></returns>
-        public string[] header
-        { 
-            get
-            {
-                var newHeader = new string[customHeader.Length + 1];
-                newHeader[0] = "time";
-                customHeader.CopyTo(newHeader, 1);
-                return newHeader;
-            }
-        }
 
         /// <summary>
         /// When the tracker should take measurements.
@@ -70,7 +56,6 @@ public string[] header
         void Reset()
         {
             objectName = gameObject.name.Replace(" ", "_").ToLower();
-            SetupDescriptorAndHeader();
         }
 
         // called by unity just before rendering the frame
@@ -90,19 +75,20 @@ void FixedUpdate()
         /// </summary>
         public void RecordRow()
         {
-            if (!recording) throw new System.InvalidOperationException("Tracker measurements cannot be taken when not in a trial!");
+            if (!recording) throw new System.InvalidOperationException("Tracker measurements cannot be taken when not recording!");
 
             UXFDataRow newRow = GetCurrentValues();
             newRow.Add(("time", Time.time));
-            data.AddCompleteRow(newRow);
+            Data.AddCompleteRow(newRow);
         }
 
         /// <summary>
         /// Begins recording.
         /// </summary>
         public void StartRecording()
         {
-            data = new UXFDataTable(header);
+            var header = baseHeaders.Concat(CustomHeader);
+            Data = new UXFDataTable(header.ToArray());
             recording = true;
         }
 
@@ -120,11 +106,6 @@ public void StopRecording()
         /// <returns></returns>
         protected abstract UXFDataRow GetCurrentValues();
 
-        /// <summary>
-        /// Override this method and define your own descriptor and header.
-        /// </summary>
-        protected abstract void SetupDescriptorAndHeader();
-
     }
 
     /// <summary>

Assets/UXF/Scripts/Etc/Trial.cs

@@ -124,7 +124,7 @@ public void End()
 
             // check no duplicate trackers
             List<string> duplicateTrackers = session.trackedObjects.Where(tracker => tracker != null)
-              .GroupBy(tracker => tracker.dataName)
+              .GroupBy(tracker => tracker.DataName)
               .Where(g => g.Count() > 1)
               .Select(y => y.Key)
               .ToList(); 
@@ -137,7 +137,7 @@ public void End()
                 try
                 {
                     tracker.StopRecording();
-                    SaveDataTable(tracker.data, tracker.dataName, dataType: UXFDataType.Trackers);
+                    SaveDataTable(tracker.Data, tracker.DataName, dataType: UXFDataType.Trackers);
                 }
                 catch (NullReferenceException)
                 {

Assets/UXF/Scripts/Trackers/MouseScreenTracker.cs

@@ -1,4 +1,5 @@
-using UnityEngine;
+using System.Collections.Generic;
+using UnityEngine;
 
 namespace UXF
 {
@@ -8,19 +9,8 @@ namespace UXF
     /// </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"
-            };
-        }
+        public override string MeasurementDescriptor => "mouse_screen";
+        public override IEnumerable<string> CustomHeader => new string[] { "pix_x", "pix_y" };
 
         /// <summary>
         /// Returns current mouse position in screen coordinates

Assets/UXF/Scripts/Trackers/MouseWorldTracker.cs

@@ -1,4 +1,5 @@
-using UnityEngine;
+using System.Collections.Generic;
+using UnityEngine;
 
 namespace UXF
 {
@@ -13,20 +14,9 @@ public class MouseWorldTracker : Tracker
         [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",
-            };
-        }
+        public override string MeasurementDescriptor => "mouse_world";
+
+        public override IEnumerable<string> CustomHeader => new string[] { "pos_x", "pos_y", "pos_z", };
 
         /// <summary>
         /// Returns current mouse position in world coordinates

Assets/UXF/Scripts/Trackers/PositionRotationTracker.cs

@@ -11,23 +11,8 @@ namespace UXF
     /// </summary>
     public class PositionRotationTracker : Tracker
     {
-        /// <summary>
-        /// Sets measurementDescriptor and customHeader to appropriate values
-        /// </summary>
-        protected override void SetupDescriptorAndHeader()
-        {
-            measurementDescriptor = "movement";
-            
-            customHeader = new string[]
-            {
-                "pos_x",
-                "pos_y",
-                "pos_z",
-                "rot_x",
-                "rot_y",
-                "rot_z"
-            };
-        }
+        public override string MeasurementDescriptor => "movement";
+        public override IEnumerable<string> CustomHeader => new string[] { "pos_x", "pos_y", "pos_z", "rot_x", "rot_y", "rot_z" };
 
         /// <summary>
         /// Returns current position and rotation values

Assets/UXF/Tests/Editor/TestTrackers.cs

@@ -164,14 +164,12 @@ public void RecordingException()
         public void DuplicateTrackersCausesError()
         {
             string objectName = session.trackedObjects[0].objectName;
-            string measurementDescriptor = session.trackedObjects[0].measurementDescriptor;
 
             bool errorCaught = false;
 
             foreach (var trial in session.Trials)
 			{
                 session.trackedObjects[0].objectName = session.trackedObjects[1].objectName;
-                session.trackedObjects[0].measurementDescriptor = session.trackedObjects[1].measurementDescriptor;
 
 				trial.Begin();
 
@@ -185,7 +183,6 @@ public void DuplicateTrackersCausesError()
                 }
 
                 session.trackedObjects[0].objectName = objectName;
-                session.trackedObjects[0].measurementDescriptor = measurementDescriptor;
 
                 trial.End();
             }

Assets/UXF/VERSION.txt

@@ -1 +1 @@
-2.3.7
+2.4.0