Class AbstractDataProvider
Abstract base class for all data providers.
Inheritance
Inherited Members
Namespace: IMLD.MixedRealityAnalysis.Core
Assembly: Assembly-CSharp.dll
Syntax
public abstract class AbstractDataProvider : MonoBehaviour
Properties
AxisDirectionX
Gets or sets the direction of the x-axis. The default is Vector3.right
.
Declaration
public Vector3 AxisDirectionX { get; protected set; }
Property Value
Type | Description |
---|---|
UnityEngine.Vector3 |
AxisDirectionY
Gets or sets the direction of the y-axis. The default is Vector3.up
.
Declaration
public Vector3 AxisDirectionY { get; protected set; }
Property Value
Type | Description |
---|---|
UnityEngine.Vector3 |
AxisDirectionZ
Gets or sets the direction of the z-axis. The default is Vector3.forward
.
Declaration
public Vector3 AxisDirectionZ { get; protected set; }
Property Value
Type | Description |
---|---|
UnityEngine.Vector3 |
AxisTransformationMatrix4x4
Gets or sets a 4x4 matrix representing the transformation of the data's coordinate system into Unity.
Declaration
public Matrix4x4 AxisTransformationMatrix4x4 { get; protected set; }
Property Value
Type | Description |
---|---|
UnityEngine.Matrix4x4 |
CurrentStudy
Gets or sets the currently loaded study.
Declaration
public StudyData CurrentStudy { get; protected set; }
Property Value
Type | Description |
---|---|
StudyData |
CurrentStudyIndex
Gets or sets the index of the currently loaded study in the StudyList.
Declaration
public int CurrentStudyIndex { get; protected set; }
Property Value
Type | Description |
---|---|
System.Int32 |
DataSets
Gets or sets a dictionary of the objects or entities in the current study, accessible by their id.
Declaration
public Dictionary<int, AnalysisObject> DataSets { get; protected set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.Int32, AnalysisObject> |
IsInitialized
Gets or sets a value indicating whether the data provider is correctly initialized.
Declaration
public bool IsInitialized { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsStudyLoaded
Gets or sets a value indicating whether loading of a study is completed.
Declaration
public bool IsStudyLoaded { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
StudyList
Gets or sets a list of StudyData that represents the parsed meta data of all studies.
Declaration
public List<StudyData> StudyList { get; protected set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<StudyData> |
StudyListReady
Gets the event that is invoked when all study configuration files have been parsed.
Declaration
public UnityEvent StudyListReady { get; }
Property Value
Type | Description |
---|---|
UnityEngine.Events.UnityEvent |
Methods
LoadStudyAsync(Int32)
Loads the study with the index given by index
.
Declaration
public abstract Task LoadStudyAsync(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | the index of the study to load. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task object |