Class StudyManager
This unity component is used to handle state changes in the study. This includes loading studies, changing the current timestamp, and so on.
Inheritance
Inherited Members
Namespace: IMLD.MixedRealityAnalysis.Core
Assembly: Assembly-CSharp.dll
Syntax
public class StudyManager : MonoBehaviour
Fields
CurrentStudyConditions
The System.Collections.Generic.List<T> of the indices of the currently active study conditions.
Declaration
public List<int> CurrentStudyConditions
Field Value
Type | Description |
---|---|
System.Collections.Generic.List<System.Int32> |
CurrentStudySessions
The System.Collections.Generic.List<T> of the indices of the currently active study sessions.
Declaration
public List<int> CurrentStudySessions
Field Value
Type | Description |
---|---|
System.Collections.Generic.List<System.Int32> |
CurrentTimeFilter
The currently active TimeFilter.
Declaration
public TimeFilter CurrentTimeFilter
Field Value
Type | Description |
---|---|
TimeFilter |
CurrentTimestamp
The current timestamp.
Declaration
public long CurrentTimestamp
Field Value
Type | Description |
---|---|
System.Int64 |
MaxTimestamp
The maximum timestamp in the study data over all currently active sessions, conditions, and study objects.
Declaration
public long MaxTimestamp
Field Value
Type | Description |
---|---|
System.Int64 |
MinTimestamp
The minimum timestamp in the study data over all currently active sessions, conditions, and study objects.
Declaration
public long MinTimestamp
Field Value
Type | Description |
---|---|
System.Int64 |
SessionFilterEventBroadcast
Event that is invoked whenever the session filter changes.
Declaration
public StudyManager.SessionFilterChangedEvent SessionFilterEventBroadcast
Field Value
Type | Description |
---|---|
StudyManager.SessionFilterChangedEvent |
StudyChangeBroadcast
Event that is invoked whenever the study id changes.
Declaration
public StudyManager.StudyChangedEvent StudyChangeBroadcast
Field Value
Type | Description |
---|---|
StudyManager.StudyChangedEvent |
TimeFilterEventBroadcast
Event that is invoked whenever the time filter changes.
Declaration
public StudyManager.TimeFilterChangedEvent TimeFilterEventBroadcast
Field Value
Type | Description |
---|---|
StudyManager.TimeFilterChangedEvent |
TimelineEventBroadcast
Event that is invoked whenever the timeline state changes.
Declaration
public StudyManager.TimelineStateChangedEvent TimelineEventBroadcast
Field Value
Type | Description |
---|---|
StudyManager.TimelineStateChangedEvent |
TimelineStatus
The current status of the timeline.
Declaration
public TimelineStatus TimelineStatus
Field Value
Type | Description |
---|---|
TimelineStatus |
Properties
PlaybackSpeed
Gets the current playback speed factor.
Declaration
public float PlaybackSpeed { get; }
Property Value
Type | Description |
---|---|
System.Single |
Methods
LoadStudy(Int32)
Loads the study with the provided index.
Declaration
public void LoadStudy(int studyIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | studyIndex | The index of the study to load. |
SetPlaybackSpeed(Single)
Sets the playback speed.
Declaration
public void SetPlaybackSpeed(float playbackSpeed)
Parameters
Type | Name | Description |
---|---|---|
System.Single | playbackSpeed | The new playback speed factor. |
StartPlayback()
Starts playback.
Declaration
public void StartPlayback()
StopPlayback()
Stops/pauses playback.
Declaration
public void StopPlayback()
UpdateSessionFilter(List<Int32>, List<Int32>)
Updates the session filter with the provided System.Collections.Generic.List<T> of sessions and conditions.
Declaration
public void UpdateSessionFilter(List<int> sessions, List<int> conditions)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<System.Int32> | sessions | The indices of the sessions to select. |
System.Collections.Generic.List<System.Int32> | conditions | The indices of the conditions to select. |
UpdateTimeFilter(Single, Single)
Updates the time filter.
Declaration
public void UpdateTimeFilter(float min, float max)
Parameters
Type | Name | Description |
---|---|---|
System.Single | min | A float between 0 and 1 indicating the lower bound of the filter. |
System.Single | max | A float between 0 and 1 indicating the upper bound of the filter. |
UpdateTimeline(TimelineStatus, Int64)
Updates the timeline with a new status and current timestamp.
Declaration
public void UpdateTimeline(TimelineStatus status, long currentTimestamp)
Parameters
Type | Name | Description |
---|---|---|
TimelineStatus | status | The new TimelineStatus. |
System.Int64 | currentTimestamp | The new timestamp. |