Class VisualizationManager
This unity component manages creation, deletion, and updating visualizations.
Inheritance
Inherited Members
Namespace: IMLD.MixedRealityAnalysis.Core
Assembly: Assembly-CSharp.dll
Syntax
public class VisualizationManager : MonoBehaviour
Fields
CoordinateSystemPrefab
The prefab for a 3D coordinate system.
Declaration
public Vis3DCoordinateSystem CoordinateSystemPrefab
Field Value
Type | Description |
---|---|
Vis3DCoordinateSystem |
TimelineControlPrefab
The prefab for the timeline control panel.
Declaration
public ViewTimelineControl TimelineControlPrefab
Field Value
Type | Description |
---|---|
ViewTimelineControl |
VisPlaceholderPrefab
The prefab for a view container.
Declaration
public ViewContainer VisPlaceholderPrefab
Field Value
Type | Description |
---|---|
ViewContainer |
VisualizationPrefabs
The list of prefabs for the generation of visualizations.
Declaration
public List<AbstractView> VisualizationPrefabs
Field Value
Type | Description |
---|---|
System.Collections.Generic.List<AbstractView> |
Properties
DataCenteringEventBroadcast
Gets the event that is raised when centering the data.
Declaration
public VisualizationManager.DataCenteringEvent DataCenteringEventBroadcast { get; }
Property Value
Type | Description |
---|---|
VisualizationManager.DataCenteringEvent |
ViewContainers
Gets a dictionary of all view containers.
Declaration
public Dictionary<int, ViewContainer> ViewContainers { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.Int32, ViewContainer> |
VisualizationCreatedEventBroadcast
Gets the event that is raised when a visualization has been created.
Declaration
public VisualizationManager.VisualizationCreatedEvent VisualizationCreatedEventBroadcast { get; }
Property Value
Type | Description |
---|---|
VisualizationManager.VisualizationCreatedEvent |
VisualizationDeletedEventBroadcast
Gets the event that is raised when a visualization has been deleted.
Declaration
public VisualizationManager.VisualizationDeletedEvent VisualizationDeletedEventBroadcast { get; }
Property Value
Type | Description |
---|---|
VisualizationManager.VisualizationDeletedEvent |
Visualizations
Gets a dictionary of all visualizations.
Declaration
public Dictionary<Guid, AbstractView> Visualizations { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.Guid, AbstractView> |
Methods
CenterData(Boolean, Boolean)
Centers or un-centers the data to the origin, based on the average position of the samples.
Declaration
public void CenterData(bool isCentering, bool syncWithRemote = true)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isCentering | Indicated whether to center or to reverse. |
System.Boolean | syncWithRemote | Indicates whether the centering should also happen on remote clients. |
CreateTimelineControl(VisProperties)
Creates a new timeline control.
Declaration
public GameObject CreateTimelineControl(VisProperties settings)
Parameters
Type | Name | Description |
---|---|---|
VisProperties | settings | The settings for the new timeline control. |
Returns
Type | Description |
---|---|
UnityEngine.GameObject | A UnityEngine.GameObject with the timeline control. |
CreateViewContainer(VisContainer, Boolean)
Creates a new ViewContainer and adds it to the list of containers.
Declaration
public void CreateViewContainer(VisContainer container, bool syncWithRemote = true)
Parameters
Type | Name | Description |
---|---|---|
VisContainer | container | The VisContainer object representing the settings for the new ViewContainer. |
System.Boolean | syncWithRemote | Indicates whether the container should also be created on remote clients. |
CreateVisualization(VisProperties, Boolean)
Creates a visualization from a VisProperties.
Declaration
public GameObject CreateVisualization(VisProperties settings, bool syncWithRemote = true)
Parameters
Type | Name | Description |
---|---|---|
VisProperties | settings | The struct containing the settings for the visualization. |
System.Boolean | syncWithRemote | Indicates whether the visualization should also be created on other clients. |
Returns
Type | Description |
---|---|
UnityEngine.GameObject | A UnityEngine.GameObject with the visualization. |
DeleteAllViewContainers(Boolean)
Deletes all existing ViewContainer.
Declaration
public void DeleteAllViewContainers(bool syncWithRemote = true)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | syncWithRemote | Indicates whether the containers should also be deleted on remote clients. |
DeleteAllVisualizations(Boolean)
Deletes all existing visualizations from the scene.
Declaration
public void DeleteAllVisualizations(bool syncWithRemote = true)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | syncWithRemote | Indicates whether the visualization should also be deleted on remote clients. |
DeleteVisualization(Guid, Boolean)
Deletes a single visualization with the provided System.Guid.
Declaration
public bool DeleteVisualization(Guid visId, bool syncWithRemote = true)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | visId | The System.Guid of the visualization. |
System.Boolean | syncWithRemote | Indicates whether the visualization should also be deleted on remote clients. |
Returns
Type | Description |
---|---|
System.Boolean | A bool indicating whether a visualization was successfully deleted. Returns false when there is no visualization with the provided System.Guid. |
GenerateCoordinateSystemVis(VisProperties)
Creates a new coordinate system.
Declaration
public GameObject GenerateCoordinateSystemVis(VisProperties settings)
Parameters
Type | Name | Description |
---|---|---|
VisProperties | settings | The settings for the new coordinate system. |
Returns
Type | Description |
---|---|
UnityEngine.GameObject | A UnityEngine.GameObject with the coordinate system. |
GetVisualizationsOfType(VisType)
Returns a System.Collections.Generic.List<T> of all visualizations of a specified type.
Declaration
public List<Guid> GetVisualizationsOfType(VisType type)
Parameters
Type | Name | Description |
---|---|---|
VisType | type | The VisType to search for. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<System.Guid> | A System.Collections.Generic.List<T> of visualizations with the provided VisType. |
Start()
Unity start function.
Declaration
public void Start()
UpdateSessionFilter(List<Int32>, List<Int32>)
Updates the session filter with the provided lists 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 list of sessions. |
System.Collections.Generic.List<System.Int32> | conditions | The list of conditions. |
UpdateVisualization(VisProperties, Boolean)
Updates an existing visualization with the provided VisProperties.
Declaration
public void UpdateVisualization(VisProperties config, bool syncWithRemote = true)
Parameters
Type | Name | Description |
---|---|---|
VisProperties | config | The struct containing the settings for the updated visualization. |
System.Boolean | syncWithRemote | Indicates whether this update should also happen on remote clients. |