CellexalVR  1.1.0
A virtual reality platform for the exploration and analysis of single-cell gene expression data
CellexalVR.Menu.Buttons.Selection.FilterButton Class Reference

Represents a button that chooses a fitler when pressed. More...

Inheritance diagram for CellexalVR.Menu.Buttons.Selection.FilterButton:
CellexalVR.Menu.Buttons.CellexalButton CellexalVR.Interaction.CellexalRaycastable

Public Member Functions

override void Click ()
 Handles what happens when the user points the controller towards the button and presses the trigger. More...
 
void SetTextActivated (bool activate)
 Sets the text and state of this button. Use if the filter is loaded/unloaded elsewhere and the button apperance should be updated. More...
 
void SetFilter (Filter filter, string name)
 Sets this buttons filter. More...
 
- Public Member Functions inherited from CellexalVR.Menu.Buttons.CellexalButton
override void OnRaycastEnter ()
 Called on the first frame that this CellexalRaycastable is hit by a CellexalRaycast. More...
 
override void OnRaycastExit ()
 Called on the first frame that this CellexalRaycastable is not hit by a CellexalRaycast anymore. More...
 
virtual void SetButtonActivated (bool activate)
 Activates or deactivates this button. Changes the sprite and makes the button not able to invoke Click until it is activated again. More...
 
void StoreState ()
 
void ToggleOutline (bool toggle, bool legend=false)
 To synchronise the outline in multi-user mode. So the outline doesnt get active unless the other users menu or tab is active. More...
 
virtual void SetHighlighted (bool highlight)
 Highlights or unhighlights this button. 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...
 

Public Attributes

TextMeshPro text
 
- 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 storedState
 
bool controllerInside = false
 
- Public Attributes inherited from CellexalVR.Interaction.CellexalRaycastable
UnityEvent OnActivate
 
UnityEvent RaycastEnter
 
UnityEvent RaycastExit
 
bool canBePushedAndPulled = true
 
bool active = true
 

Protected Member Functions

void Start ()
 
- Protected Member Functions inherited from CellexalVR.Menu.Buttons.CellexalButton
virtual void Awake ()
 
virtual void HelpClick ()
 
void Exit ()
 

Properties

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
SpriteRenderer spriteRenderer
 
MeshRenderer meshRenderer
 

Detailed Description

Represents a button that chooses a fitler when pressed.

Member Function Documentation

◆ Click()

override void CellexalVR.Menu.Buttons.Selection.FilterButton.Click ( )
virtual

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

Implements CellexalVR.Menu.Buttons.CellexalButton.

◆ SetFilter()

void CellexalVR.Menu.Buttons.Selection.FilterButton.SetFilter ( Filter  filter,
string  name 
)

Sets this buttons filter.

Parameters
filterThe filter to set.
nameThe name of the filter (the name of the file it came from).

◆ SetTextActivated()

void CellexalVR.Menu.Buttons.Selection.FilterButton.SetTextActivated ( bool  activate)

Sets the text and state of this button. Use if the filter is loaded/unloaded elsewhere and the button apperance should be updated.

Parameters
activateTrue if this buttons filter has been loaded, false if it has been unloaded.

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