CellexalVR.AnalysisObjects.GroupingLegend Class Reference

Represents a legend that contains GroupingLegendEntry. More...

Inheritance diagram for CellexalVR.AnalysisObjects.GroupingLegend:

Public Member Functions
void	AddEntry (string groupName, int numberOfCells, Color color)
	Adds a new group to the legend. More...
void	RemoveEntry (string groupName)
	Removes a group from the legend. More...
void	ClearLegend ()
	Clears the legend of all data. More...
void	AddOrUpdateEntry (string groupName, int numberOfCellsToAdd, Color color)
	Updates an existing group or, if no group with the specified name exists, creates a new group. More...
void	ChangePage (bool incrementPageNbr)
	Changes the current page. More...
Public Member Functions inherited from CellexalVR.AnalysisObjects.EnvironmentTab
void	SetTabActive (bool active)
	Enables or disables the content gameobject of this tab. More...
Public Member Functions inherited from CellexalVR.Interaction.CellexalRaycastable
virtual void	OnRaycastHit (RaycastHit hitInfo, CellexalRaycast raycaster)
	Called by CellexalRaycast.Update every frame that a raycast hit this target. More...
virtual void	OnRaycastEnter ()
	Called on the first frame that this CellexalRaycastable is hit by a CellexalRaycast. More...
virtual void	OnRaycastExit ()
	Called on the first frame that this CellexalRaycastable is not hit by a CellexalRaycast anymore. More...

Public Attributes
ReferenceManager	referenceManager
GameObject	entryPrefab
GameObject	extraColumn
TMPro.TextMeshPro	pageNumberText
Public Attributes inherited from CellexalVR.AnalysisObjects.EnvironmentTab
EnvironmentTabButton	tabButton
GameObject	contentParent
EnvironmentMenuWithTabs	parentMenu
Public Attributes inherited from CellexalVR.Interaction.CellexalRaycastable
UnityEvent	OnActivate
UnityEvent	RaycastEnter
UnityEvent	RaycastExit
bool	canBePushedAndPulled = true
bool	active = true

Detailed Description

Represents a legend that contains GroupingLegendEntry.

Member Function Documentation

AddEntry()

void CellexalVR.AnalysisObjects.GroupingLegend.AddEntry	(	string	groupName,
		int	numberOfCells,
		Color	color
	)

Adds a new group to the legend.

Parameters

groupName	The name of the group.
numberOfCells	The number of cells the group has.
color	The color that represents the group.

AddOrUpdateEntry()

void CellexalVR.AnalysisObjects.GroupingLegend.AddOrUpdateEntry	(	string	groupName,
		int	numberOfCellsToAdd,
		Color	color
	)

Updates an existing group or, if no group with the specified name exists, creates a new group.

Parameters

groupName	The name of the group.
numberOfCellsToAdd	The number of cells to add or remove from the group.
color	The color the group should have if it is created. If numberOfCellsToAdd is negative (cells are removed from the group), this parameter does not matter.

ChangePage()

void CellexalVR.AnalysisObjects.GroupingLegend.ChangePage

(

bool

incrementPageNbr

)

Changes the current page.

Parameters

incrementPageNbr

True if the page number should be incremented by one, false if it should be decremented by one.

ClearLegend()

void CellexalVR.AnalysisObjects.GroupingLegend.ClearLegend

(

)

Clears the legend of all data.

RemoveEntry()

void CellexalVR.AnalysisObjects.GroupingLegend.RemoveEntry

(

string

groupName

)

Removes a group from the legend.

Parameters

groupName

The name of the group to remove.

---

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

• cellexalvr_cloudxr/Assets/Scripts/AnalysisObjects/GroupingLegend.cs