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:

Public Types
enum	Mode { SINGLE, BOOLEAN_EXPR, BIG_FOLDER }

Public Member Functions
override void	Click ()
	Handles what happens when the user points the controller towards the button and presses the trigger. More...
void	ColorAttribute (bool toggle)
	Called when toggling all attributes using the select all button. More...
void	SwitchModeToBigFolder (Mode m)
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, int colorIndex)
	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)
	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
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	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
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
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.

ColorAttribute()

void CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton.ColorAttribute

(

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

attribute	The name of the attribute.
color	The 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,
		int	colorIndex
	)

Sets which attribute this button should show when pressed.

Parameters

attribute	The name of the attribute.
displayedName	The text that should be displayed on the button.
color	The color that the cells in possesion of the attribute should get.

SetHighlighted()

override void CellexalVR.Menu.Buttons.Attributes.ColorByAttributeButton.SetHighlighted ( bool  highlight )

virtual

Highlights or unhighlights this button.

Parameters

highlight

True to highlight, false to unhighlight.

Reimplemented from CellexalVR.Menu.Buttons.CellexalButton.

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:

• cellexalvr_cloudxr/Assets/Scripts/Menu/Buttons/Attributes/ColorByAttributeButton.cs