CellexalVR  0.13.0
A virtual reality platform for the exploration and analysis of single-cell gene expression data
CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton Class Reference

Represents a button that colors all graphs according to an attribute. More...

Inheritance diagram for CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton:
CellexalVR.Menu.Buttons.CellexalButton

Public Types

enum  Mode { SINGLE, BOOLEAN_EXPR }
 

Public Member Functions

override void Click ()
 Handles what happens when the user points the controller towards the button and presses the trigger. More...
 
void ColourAttribute (bool toggle)
 Called when toggling all attributes using the select all button. More...
 
void SetAttribute (string attribute, Color color)
 To synchronise the outline in multi-user mode. So the outline doesnt get active if the other users menu or tab is active. More...
 
void SetAttribute (string attribute, string displayedName, Color color)
 Sets which attribute this button should show when pressed. More...
 
void SwitchMode ()
 Switches between boolean expression mode and normal mode. More...
 
override void SetHighlighted (bool highlight)
 
- Public Member Functions inherited from CellexalVR.Menu.Buttons.CellexalButton
virtual void SetButtonActivated (bool activate)
 
void StoreState ()
 
void ToggleOutline (bool toggle)
 To synchronise the outline in multi-user mode. So the outline doesnt get active if the other users menu or tab is active. More...
 

Public Attributes

TMPro.TextMeshPro description
 
Color booleanNotIncludedColor
 
Color booleanYesColor
 
Color booleanNoColor
 
bool colored = false
 
AttributeSubMenu parentMenu
 
- Public Attributes inherited from CellexalVR.Menu.Buttons.CellexalButton
ReferenceManager referenceManager
 
TMPro.TextMeshPro descriptionText
 
GameObject infoMenu
 
GameObject activeOutline
 
Color meshStandardColor = Color.black
 
Color meshHighlightColor = Color.white
 
Color meshDeactivatedColor = Color.grey
 
Sprite standardTexture = null
 
Sprite highlightedTexture = null
 
Sprite deactivatedTexture = null
 
int popupChoice = 0
 
bool buttonActivated = true
 
bool storedState
 
bool controllerInside = false
 

Protected Member Functions

void Start ()
 
- Protected Member Functions inherited from CellexalVR.Menu.Buttons.CellexalButton
virtual void Awake ()
 
virtual void Update ()
 
virtual void HelpClick ()
 
void OnTriggerEnter (Collider other)
 
void Exit ()
 
void OnTriggerExit (Collider other)
 

Properties

string Attribute [get, set]
 
Mode CurrentMode = Mode.SINGLE [get, set]
 
AttributeLogic CurrentBooleanExpressionState = AttributeLogic.NOT_INCLUDED [get]
 
override string Description [get]
 
- Properties inherited from CellexalVR.Menu.Buttons.CellexalButton
abstract string Description [get]
 A string that briefly explains what this button does. More...
 

Additional Inherited Members

- Protected Attributes inherited from CellexalVR.Menu.Buttons.CellexalButton
SteamVR_TrackedObject rightController
 
SteamVR_Controller.Device device
 
SpriteRenderer spriteRenderer
 
MeshRenderer meshRenderer
 

Detailed Description

Represents a button that colors all graphs according to an attribute.

Member Function Documentation

◆ Click()

override void CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton.Click ( )
virtual

Handles what happens when the user points the controller towards the button and presses the trigger.

Implements CellexalVR.Menu.Buttons.CellexalButton.

◆ ColourAttribute()

void CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton.ColourAttribute ( bool  toggle)

Called when toggling all attributes using the select all button.

◆ SetAttribute() [1/2]

void CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton.SetAttribute ( string  attribute,
Color  color 
)

To synchronise the outline in multi-user mode. So the outline doesnt get active if the other users menu or tab is active.

Sets which attribute this button should show when pressed.

Parameters
attributeThe name of the attribute.
colorThe color that the cells in possesion of the attribute should get.

◆ SetAttribute() [2/2]

void CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton.SetAttribute ( string  attribute,
string  displayedName,
Color  color 
)

Sets which attribute this button should show when pressed.

Parameters
attributeThe name of the attribute.
displayedNameThe text that should be displayed on the button.
colorThe color that the cells in possesion of the attribute should get.

◆ SwitchMode()

void CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton.SwitchMode ( )

Switches between boolean expression mode and normal mode.


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