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

A button that animates a sliding effect between two states. Once sliding is complete some actions are performed. Typically a toggle button. More...

Inheritance diagram for CellexalVR.Menu.Buttons.SliderButton:
CellexalVR.Menu.Buttons.CellexalButton CellexalVR.Interaction.CellexalRaycastable CellexalVR.Menu.Buttons.General.ScreenshotLayerToggleButton CellexalVR.Menu.Buttons.Networks.ToggleAllArcsButton CellexalVR.Menu.Buttons.Networks.ToggleAllCombinedArcsButton CellexalVR.Menu.Buttons.Slicing.ReferenceOrganToggleButton CellexalVR.Menu.Buttons.Slicing.SingleSliceViewToggleButton CellexalVR.Menu.Buttons.Slicing.SliceAxisToggleButton CellexalVR.Menu.Buttons.Slicing.SlicingModeToggleButton CellexalVR.Menu.Buttons.ToggleUnSelectedPoints

Public Member Functions

override void Click ()
 Actions are in this case not directly on click but first sliding animation. More...
 
override void SetHighlighted (bool highlight)
 Highlights or unhighlights this button. 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...
 
- 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

Transform rightSide
 
Transform leftSide
 
GameObject slider
 
float slideTime
 
GameObject background
 
bool startState
 
- 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

virtual void MultiUserSynchronise ()
 
abstract void ActionsAfterSliding ()
 Actions to be performed once animation is complete. More...
 
- Protected Member Functions inherited from CellexalVR.Menu.Buttons.CellexalButton
virtual void Awake ()
 
virtual void HelpClick ()
 
void Exit ()
 

Protected Attributes

bool currentState
 
- Protected Attributes inherited from CellexalVR.Menu.Buttons.CellexalButton
SpriteRenderer spriteRenderer
 
MeshRenderer meshRenderer
 

Properties

bool CurrentState [get, set]
 
- Properties inherited from CellexalVR.Menu.Buttons.CellexalButton
abstract string Description [get]
 A string that briefly explains what this button does. More...
 

Detailed Description

A button that animates a sliding effect between two states. Once sliding is complete some actions are performed. Typically a toggle button.

Member Function Documentation

◆ ActionsAfterSliding()

◆ Click()

override void CellexalVR.Menu.Buttons.SliderButton.Click ( )
virtual

Actions are in this case not directly on click but first sliding animation.

Implements CellexalVR.Menu.Buttons.CellexalButton.

◆ SetHighlighted()

override void CellexalVR.Menu.Buttons.SliderButton.SetHighlighted ( bool  highlight)
virtual

Highlights or unhighlights this button.

Parameters
highlightTrue to highlight, false to unhighlight.

Reimplemented from CellexalVR.Menu.Buttons.CellexalButton.


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