Abstract general purpose class that represents a tool button on the menu. Tool buttons have to keep track of the controller model unlike the other buttons. More...

Inheritance diagram for CellexalVR.Menu.Buttons.CellexalToolButton:

Public Member Functions
override void	Click ()
	Handles what happens when the user points the controller towards the button and presses the trigger. More...

override void	SetHighlighted (bool highlight)
	Highlights or unhighlights this button. More...

override 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...

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...

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
Sprite	activatedTexture = null

Sprite	highlightActivatedTexture = null

Color	meshActivatedColor = Color.blue

bool	toolActivated

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
override void	Awake ()

void	TurnOn ()

void	TurnOff ()

Protected Member Functions inherited from CellexalVR.Menu.Buttons.CellexalButton
virtual void	HelpClick ()

void	Exit ()

Protected Attributes
ControllerModelSwitcher	controllerModelSwitcher

Protected Attributes inherited from CellexalVR.Menu.Buttons.CellexalButton
SpriteRenderer	spriteRenderer

MeshRenderer	meshRenderer

Properties
abstract ControllerModelSwitcher.Model	ControllerModel `[get]`

Properties inherited from CellexalVR.Menu.Buttons.CellexalButton
abstract string	Description `[get]`
	A string that briefly explains what this button does. More...

Detailed Description

Abstract general purpose class that represents a tool button on the menu. Tool buttons have to keep track of the controller model unlike the other buttons.

Member Function Documentation

◆ Click()

override void CellexalVR.Menu.Buttons.CellexalToolButton.Click ( )

virtual

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

Implements CellexalVR.Menu.Buttons.CellexalButton.

Reimplemented in CellexalVR.Menu.Buttons.Tools.WebBrowserButton, and CellexalVR.Menu.Buttons.Tools.KeyboardButton.

◆ SetButtonActivated()

override void CellexalVR.Menu.Buttons.CellexalToolButton.SetButtonActivated ( bool activate )

virtual

Activates or deactivates this button. Changes the sprite and makes the button not able to invoke Click until it is activated again.

Parameters

activate True to activate this button, false to deactivate.

Reimplemented from CellexalVR.Menu.Buttons.CellexalButton.

◆ SetHighlighted()

override void CellexalVR.Menu.Buttons.CellexalToolButton.SetHighlighted ( bool highlight )

virtual

Highlights or unhighlights this button.

Parameters

highlight True to highlight, false to unhighlight.

Reimplemented from CellexalVR.Menu.Buttons.CellexalButton.

Reimplemented in CellexalVR.Menu.Buttons.Tools.MinimizeToolButton.

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

cellexalvr_cloudxr/Assets/Scripts/Menu/Buttons/CellexalToolButton.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ Click()

◆ SetButtonActivated()

◆ SetHighlighted()