CellexalVR  1.1.0
A virtual reality platform for the exploration and analysis of single-cell gene expression data
CellexalVR.General.SessionHistoryList Class Reference

Keeps track of things done in the current session. Such as selections, colouring by gene or index. Creates clickable panels to reselect/recolour. Similar to previous searches list on keyboard but contains selections and other more general stuff as well. Can be accessed without keyboard. More...

Inheritance diagram for CellexalVR.General.SessionHistoryList:

Public Member Functions

bool Contains (string name, Definitions.HistoryEvent type)
 Checks if the list already contains an entry. More...
 
string AddEntry (string entryName, Definitions.HistoryEvent type, int id=-1)
 Adds an entry to the list of saved searches. New entries are added to the top of the list and all entries below that are not locked are pushed down one step. If the list is full, the bottom most entry will be removed from the list. More...
 
void ClearList ()
 Clears the list. More...
 
ClickableHistoryPanel GetPanel (string panelName)
 

Public Attributes

ReferenceManager referenceManager
 Represents the list of the 10 previous things done in session. More...
 
GameObject listNodePrefab
 
List< GameObject > listNodes = new List<GameObject>()
 
List< ClickableHistoryPanelsessionHistoryListNodes = new List<ClickableHistoryPanel>()
 

Detailed Description

Keeps track of things done in the current session. Such as selections, colouring by gene or index. Creates clickable panels to reselect/recolour. Similar to previous searches list on keyboard but contains selections and other more general stuff as well. Can be accessed without keyboard.

Member Function Documentation

◆ AddEntry()

string CellexalVR.General.SessionHistoryList.AddEntry ( string  entryName,
Definitions.HistoryEvent  type,
int  id = -1 
)

Adds an entry to the list of saved searches. New entries are added to the top of the list and all entries below that are not locked are pushed down one step. If the list is full, the bottom most entry will be removed from the list.

Parameters
nameThe name of the thing we are adding to the list.
typeThe type of the thing.
coloringMethodThe method of coloring that used.
idOptional argument for unique id of entry to be able to recreate a copy. Can be for example a layoutseed for networks so that layout will be the same when recreated.
Returns

◆ ClearList()

void CellexalVR.General.SessionHistoryList.ClearList ( )

Clears the list.

◆ Contains()

bool CellexalVR.General.SessionHistoryList.Contains ( string  name,
Definitions.HistoryEvent  type 
)

Checks if the list already contains an entry.

Parameters
nameTHe name of the thing in the entry.
typeThe type of the entry.
coloringMethodThe coloring method that was used.
Returns
True if an entry of this kind was already in the list, false otherwise.

Member Data Documentation

◆ referenceManager

ReferenceManager CellexalVR.General.SessionHistoryList.referenceManager

Represents the list of the 10 previous things done in session.


The documentation for this class was generated from the following file: