Merge pull request #142 from ahmed-shariff/feat/block-events

Adding OnBlockBegin and OnBlockEnd UnityEvents

Author: jackbrookes

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

@@ -108,15 +108,23 @@ protected override void DrawInspector()
 
                     EditorGUILayout.Space();
                     EditorGUILayout.HelpBox(GetTooltip(session.GetType().GetField("onSessionBegin")).tooltip, MessageType.Info);
-                    DrawPropertiesFromUpTo("onSessionBegin", "onTrialBegin");
+                    DrawPropertiesFromUpTo("onSessionBegin", "onBlockBegin");
+
+                    EditorGUILayout.Space();
+                    EditorGUILayout.HelpBox(GetTooltip(session.GetType().GetField("onBlockBegin")).tooltip, MessageType.Info);
+                    DrawPropertiesFromUpTo("onBlockBegin", "onTrialBegin");
 
                     EditorGUILayout.Space();
                     EditorGUILayout.HelpBox(GetTooltip(session.GetType().GetField("onTrialBegin")).tooltip, MessageType.Info);
                     DrawPropertiesFromUpTo("onTrialBegin", "onTrialEnd");
 
                     EditorGUILayout.Space();
                     EditorGUILayout.HelpBox(GetTooltip(session.GetType().GetField("onTrialEnd")).tooltip, MessageType.Info);
-                    DrawPropertiesFromUpTo("onTrialEnd", "preSessionEnd");
+                    DrawPropertiesFromUpTo("onTrialEnd", "onBlockEnd");
+
+                    EditorGUILayout.Space();
+                    EditorGUILayout.HelpBox(GetTooltip(session.GetType().GetField("onBlockEnd")).tooltip, MessageType.Info);
+                    DrawPropertiesFromUpTo("onBlockEnd", "preSessionEnd");
 
                     EditorGUILayout.Space();
                     EditorGUILayout.HelpBox(GetTooltip(session.GetType().GetField("preSessionEnd")).tooltip, MessageType.Info);

Assets/UXF/Scripts/Etc/Events.cs

@@ -15,6 +15,15 @@ public class SessionEvent : UnityEvent<Session>
 
     }
 
+    /// <summary>
+    /// Event containing a Block as a parameter
+    /// </summary>
+    [Serializable]
+    public class BlockEvent : UnityEvent<Block>
+    {
+
+    }
+
     /// <summary>
     /// Event containing a Trial as a parameter
     /// </summary>

Assets/UXF/Scripts/Etc/Trial.cs

@@ -119,6 +119,12 @@ public void Begin()
                     Utilities.UXFDebugLogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
                 }
             }
+
+            if (this == block.firstTrial)
+            {
+                session.onBlockBegin.Invoke(block);
+            }
+
             session.onTrialBegin.Invoke(this);
         }
 
@@ -137,6 +143,11 @@ public void End()
             }
 
             session.onTrialEnd.Invoke(this);
+
+            if (this == block.lastTrial)
+            {
+                session.onBlockEnd.Invoke(block);
+            }
         }
 
         public bool CheckDataTypeIsValid(string dataName, UXFDataType dataType)

Assets/UXF/Scripts/Session.cs

@@ -93,6 +93,13 @@ public class Session : MonoBehaviour, IExperimentUnit, IDataAssociatable
         [Tooltip("Items in this event will be triggered when the session begins. Useful generating your trials & blocks, setting up the scene, and triggering the first trial.")]
         public SessionEvent onSessionBegin = new SessionEvent();
 
+        /// <summary>
+        /// Event(s) to trigger when a block begins. Can pass the instance of the Block as a dynamic argument
+        /// </summary>
+        /// <returns></returns>
+        [Tooltip("Items in this event will be triggered each time a block begins.")]
+        public BlockEvent onBlockBegin = new BlockEvent();
+
         /// <summary>
         /// Event(s) to trigger when a trial begins. Can pass the instance of the Trial as a dynamic argument
         /// </summary>
@@ -107,6 +114,13 @@ public class Session : MonoBehaviour, IExperimentUnit, IDataAssociatable
         [Tooltip("Items in this event will be triggered each time a trial ends. Useful for collecting results from the trial as well as showing feedback.")]
         public TrialEvent onTrialEnd = new TrialEvent();
 
+        /// <summary>
+        /// Event(s) to trigger when a block ends. Can pass the instance of the Block as a dynamic argument
+        /// </summary>
+        /// <returns></returns>
+        [Tooltip("Items in this event will be triggered each time a block ends.")]
+        public BlockEvent onBlockEnd = new BlockEvent();
+
         /// <summary>
         /// Event(s) to trigger just before the session has ended. If you wish to perform any summary statistics or write any final session data this is the time to do it. Do not use this event to quit the application.
         /// </summary>
@@ -486,15 +500,17 @@ Trial GetFirstTrial()
         Trial GetLastTrial()
         {
             if (blocks.Count == 0) throw new NoSuchTrialException("There is no last trial because no blocks have been created!");
-            
+
             Block lastValidBlock;
+            Trial lastTrial;
             int i = blocks.Count - 1;
             while (i >= 0)
             {
                 lastValidBlock = blocks[i];
-                if (lastValidBlock.trials.Count > 0)
+                lastTrial = lastValidBlock.lastTrial;
+                if (lastTrial != null)
                 {
-                    return lastValidBlock.trials[lastValidBlock.trials.Count - 1];
+                    return lastTrial;
                 }
                 i--;
             }