CellexalVR.Interaction.FilterNameKeyboardHandler Class Reference

Inheritance diagram for CellexalVR.Interaction.FilterNameKeyboardHandler:

Public Member Functions
override void	Shift ()
	Switches between uppercase and lowercase layout. More...
override void	NumChar ()
	Switches between lowercase and special layout. More...
void	UpdateFilterFromFilterCreator ()
void	BuildKeyboard ()
Public Member Functions inherited from CellexalVR.Interaction.KeyboardHandler
Vector4	ScaleCorrection ()
	Gets the scale correction for the keyboard shader. More...
void	SetMaterials (Material keyNormalMaterial, Material keyHighlightMaterial, Material keyPressedMaterial)
	Sets the materials on all keys. See ClickablePanel.SetMaterials(Material, Material, Material). More...
void	AddMaterials (params Material[] mats)
void	Pulse (Vector2 pos)
	Displays a pulse. More...
virtual void	UpdateLaserCoords (Vector2 pos)
	Updates the coordinates for the laser hit animation. More...
void	AddText (string add, bool invokeMultiuserEvent)
	Adds text to the output. More...
void	BackSpace (bool invokeMultiuserEvent=false)
	Removes the last typed letter. More...
void	Clear ()
	Clears the output. More...
void	Clear (bool invokeMultiuserEvent=false)
	Clears the output. More...
void	SubmitOutput (bool invoke=true)
	Colors all graphs based on what was typed. More...
string	Text ()
	Returns the currently typed text. More...
void	DismissKeyboard ()
	Clears all outputs and disables this keyboard. More...
void	SetAllOutputs (string text)
	Sets all outputs to a text. More...
Vector2	ToUv2Coord (Vector3 dir)
	Converts a direction to a uv2 coordinate on the keyboard. This function can return uv2 coordinates that are not actually on the keyboard if there is no keyboard in that direction. More...
virtual bool	BuildKeyboard (KeyboardHandler prefab)
	Builds the keyboard by creating the meshes and positioning everything. More...
Mesh	CreateNineSlicedQuad (Vector2 uv2min, Vector2 uv2max, Vector2 size, float anglePerUnit, Vector2 keyboardSize)
	Creates a nine sliced quad that is used for the panels on the keyboard. This lets us use a texture with a border that won't be stretched over non-square panels. Meshes will be curved along a circle arc with the angle anglePerUnit multiplied by the x component of size and with the radius distance . More...

Properties
override string[][]	Layouts [get, protected set]
Properties inherited from CellexalVR.Interaction.KeyboardHandler
int	CurrentLayout [get, protected set]
abstract string[][]	Layouts [get, protected set]

Additional Inherited Members
Public Attributes inherited from CellexalVR.Interaction.KeyboardHandler
CellexalVR.General.ReferenceManager	referenceManager
GameObject	keysParentObject
TMPro.TextMeshPro	output
List< TMPro.TextMeshPro >	additionalOutputs
float	height = 5f
float	anglePerUnit = 5f
float	distance = 8f
string	placeholder = "Enter a name"
bool	clearOnEnter = true
KeyboardEvent	OnEdit
KeyboardEvent	OnEditMultiuser
KeyboardEvent	OnEnter
KeyboardEvent	OnAnnotate
Vector2	minPos
Vector2	maxPos
List< Material >	materials
Protected Member Functions inherited from CellexalVR.Interaction.KeyboardHandler
virtual void	Start ()
virtual IEnumerator	PulseCoroutine ()
	Uses the Keyboard shader to play a pulse anmimation. More...
void	SetVectors (string name, Vector4 value)
void	SetFloats (string name, float value)
void	GatherKeys ()
bool	GatherKeys (KeyboardHandler prefabInstance)
	Gathers the keys from the scene. More...
void	SwitchLayout (string[] layout)
	Switches the layout of the keyboard. More...
void	OpenPrefab< T > (out GameObject outerMostPrefab, out T scriptOnPrefab)
	Helper method for inherited classes to open the correct prefab. Remember to call ClosePrefab(GameObject) after. More...
void	ClosePrefab (GameObject prefab)
	Helper method for inherited clases to close the correct prefab. More...
Protected Attributes inherited from CellexalVR.Interaction.KeyboardHandler
KeyboardPanel[]	sortedKeys
string	prefabFolderPath = "Assets/Prefabs/Keyboards"
string	prefabPath

Member Function Documentation

NumChar()

override void CellexalVR.Interaction.FilterNameKeyboardHandler.NumChar ( )

virtual

Switches between lowercase and special layout.

Reimplemented from CellexalVR.Interaction.KeyboardHandler.

Shift()

override void CellexalVR.Interaction.FilterNameKeyboardHandler.Shift ( )

virtual

Switches between uppercase and lowercase layout.

Reimplemented from CellexalVR.Interaction.KeyboardHandler.

Property Documentation

Layouts

override string [][] CellexalVR.Interaction.FilterNameKeyboardHandler.Layouts

getprotected set

Initial value:

= {
            
            new string[] { "q", "w", "e", "r", "t", "y", "u", "i", "o", "p",
                           "Shift", "a", "s", "d", "f", "g", "h", "j", "k", "l",
                           "123\n!#%", "z", "x", "c", "v", "b", "n", "m", "Back", "Clear",
                           "Enter"},
            
            new string[] { "Q", "W", "E", "R", "T", "Y", "U", "I", "O", "P",
                           "Shift", "A", "S", "D", "F", "G", "H", "J", "K", "L",
                           "123\n!#%", "Z", "X", "C", "V", "B", "N", "M", "Back", "Clear",
                           "Enter"},
            
            new string[] {  "1", "2", "3", "4", "5", "6", "7", "8", "9", "0",
                            "Shift", "!", "#", "%", "&", "/", "(", ")", "=", "@",
                            "ABC\nabc", "\\", "-", "_", ".", ":", ",", ";", "Back", "Clear",
                            "Enter" }
        }

---

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

• Assets/Scripts/Interaction/FilterNameKeyboardHandler.cs