Skip to content

added pause/resume to Tracker.cs #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 20, 2023
Merged

added pause/resume to Tracker.cs #152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62bb584
added pause/unpause to Tracker.cs
martinmmueller Feb 15, 2023
39c59f9
Update Tracker.cs
martinmmueller Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 68 additions & 12 deletions Assets/UXF/Scripts/Etc/Tracker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@
namespace UXF
{
/// <summary>
/// Create a new class that inherits from this component to create custom tracking behaviour on a frame-by-frame basis.
/// Create a new class that inherits from this component to create custom tracking behaviour
/// on a frame-by-frame basis.
/// </summary>
public abstract class Tracker : MonoBehaviour
{
private bool recording = false;
private static string[] baseHeaders = new string[] { "time" };
private TrackerState currentState = TrackerState.Stopped;

/// <summary>
/// Name of the object used in saving
Expand All @@ -36,20 +37,27 @@ public string DataName
{
get
{
Debug.AssertFormat(MeasurementDescriptor.Length > 0, "No measurement descriptor has been specified for this Tracker!");
Debug.AssertFormat(MeasurementDescriptor.Length > 0,
"No measurement descriptor has been specified for this Tracker!");
return string.Join("_", new string[]{ objectName, MeasurementDescriptor });
}
}

public bool Recording { get { return recording; } }
public bool Recording { get { return currentState == TrackerState.Recording; } }

public UXFDataTable Data { get; private set; } = new UXFDataTable();


/// <summary>
/// The current state of the tracker.
/// </summary>
public TrackerState CurrentState { get => currentState; }

/// <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.")]
[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
Expand All @@ -61,21 +69,22 @@ void Reset()
// called by unity just before rendering the frame
void LateUpdate()
{
if (recording && updateType == TrackerUpdateType.LateUpdate) RecordRow();
if (Recording && updateType == TrackerUpdateType.LateUpdate) RecordRow();
}

// called by unity when physics simulations are run
void FixedUpdate()
{
if (recording && updateType == TrackerUpdateType.FixedUpdate) RecordRow();
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 recording!");
if (!Recording) throw new System.InvalidOperationException(
"Tracker measurements cannot be taken when not recording!");

UXFDataRow newRow = GetCurrentValues();
newRow.Add(("time", Time.time));
Expand All @@ -87,17 +96,54 @@ public void RecordRow()
/// </summary>
public void StartRecording()
{
if (currentState == TrackerState.Recording)
{
Utilities.UXFDebugLogWarning($"Start command received for tracker in state: '{TrackerState.Recording}'." +
" This will dump exisiting data! " +
$"If you want to restart a paused tracker, use '{nameof(ResumeRecording)}()' instead.");
}
var header = baseHeaders.Concat(CustomHeader);
Data = new UXFDataTable(header.ToArray());
recording = true;
currentState = TrackerState.Recording;
}

/// <summary>
/// Stops recording.
/// </summary>
public void StopRecording()
{
recording = false;
if (currentState != TrackerState.Recording)
{
Utilities.UXFDebugLogWarning($"Stop command received for tracker in state: '{currentState}'." +
$" This should only be called when tracker is in state '{TrackerState.Recording}'");
}
currentState = TrackerState.Stopped;
}

/// <summary>
/// Pauses recording.
/// </summary>
public void PauseRecording()
{
if (currentState != TrackerState.Recording)
{
Utilities.UXFDebugLogWarning($"Pause command received for tracker in state: '{currentState}'." +
$"This should only be called when tracker is in state '{TrackerState.Recording}'");
}
currentState = TrackerState.Paused;
}

/// <summary>
/// Resumes recording.
/// </summary>
public void ResumeRecording()
{
if (currentState != TrackerState.Paused)
{
Utilities.UXFDebugLogWarning($"Resume command received for tracker in state: '{currentState}'." +
$"This should only be called when tracker is in state '{TrackerState.Paused}'");
}
currentState = TrackerState.Recording;
}

/// <summary>
Expand All @@ -109,10 +155,20 @@ public void StopRecording()
}

/// <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.
/// 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
}

/// <summary>
/// The possible states a tracker can be in.
/// </summary>
public enum TrackerState
{
Recording, Paused, Stopped
}
}