Meta Developers

enum	KeyboardPosition { KeyboardPosition.Far = 0, KeyboardPosition.Near = 1, KeyboardPosition.Direct = 1, KeyboardPosition.Custom = 2 } The initial position of the keyboard, which determines the input style used to type.
enum	InputSource { InputSource.ControllerLeft , InputSource.ControllerRight , InputSource.HandLeft , InputSource.HandRight }

Events

Action< string >	CommitText ( ) Occurs when text has been committed @params (string text)
Action	Backspace ( ) Occurs when a backspace is pressed.
Action	Enter ( ) Occurs when a return key is pressed.
Action	KeyboardShown ( ) Occurs when keyboard is shown.
Action	KeyboardHidden ( ) Occurs when keyboard is hidden.

Properties

Collider	Collider`[Get]`
InputField	TextCommitField`[Get]`
ITextHandler	TextHandler`[Get]`

Data Fields

Transform	leftControllerRootTransform`[Get]` Configure with the transform representing the left controller input.
Transform	leftControllerDirectTransform`[Get]`
Transform	rightControllerRootTransform`[Get]` Configure with the transform representing the right controller input.
Transform	rightControllerDirectTransform`[Get]`
bool	controllerDirectInteraction`[Get]` Enables the controllers to directly interact with the keyboard.
bool	controllerRayInteraction`[Get]` Enables the controllers to send ray interactions to the keyboard.
OVRPhysicsRaycaster	controllerRaycaster`[Get]` Configures the raycast mask used when sending raycast controller input to the keyboard.
OVRHand	handLeft`[Get]` The OVRHand representing the left hand.
OVRHand	handRight`[Get]` The OVRHand representing the right hand.
bool	handDirectInteraction`[Get]` Enables tracked hands to directly interact with the keyboard.
bool	handRayInteraction`[Get]` Enables tracked hands to send ray interactions to the keyboard.
OVRPhysicsRaycaster	handRaycaster`[Get]` Configures the raycast mask used when sending raycast hand input to the keyboard.
Shader	keyboardModelShader`[Get]` The shader used to render the keyboard’s glTF materials.
Shader	keyboardModelAlphaBlendShader`[Get]` The shader used to render the keyboard’s glTF alpha blended materials.
bool	InputEnabled`[Get]` If false, prevents all keyboard input.
CommitTextUnityEvent	CommitTextEvent`[Get]`
UnityEvent	BackspaceEvent`[Get]`
UnityEvent	EnterEvent`[Get]`
UnityEvent	KeyboardShownEvent`[Get]`
UnityEvent	KeyboardHiddenEvent`[Get]`

Public Member Functions

void	UseSuggestedLocation ( KeyboardPosition position ) Updates the keyboard to a reference position.
void	SendVirtualKeyboardRayInput ( Transform inputTransform, InputSource source, bool isPressed, bool useRaycastMask ) Sends a ray input to the keyboard from a given transform.
void	SendVirtualKeyboardDirectInput ( Vector3 position, InputSource source, bool isPressed, Transform interactorRootTransform ) Sends a direct input to the keyboard from a given transform.
void	ChangeTextContext ( string textContext ) Enables custom handling of text context.
void	AutoPopulate ( )

Details

Member Enumerations

enum OVRVirtualKeyboard.KeyboardPosition

The initial position of the keyboard, which determines the input style used to type.

Enumerator

Far	= 0
Near	= 1
Direct	= 1
Custom	= 2

enum OVRVirtualKeyboard.InputSource

Enumerator

ControllerLeft
ControllerRight
HandLeft
HandRight

Events

Action<string> OVRVirtualKeyboard.CommitText ( )
Occurs when text has been committed @params (string text)

Action OVRVirtualKeyboard.Backspace ( )
Occurs when a backspace is pressed.

Action OVRVirtualKeyboard.Enter ( )
Occurs when a return key is pressed.

Action OVRVirtualKeyboard.KeyboardShown ( )
Occurs when keyboard is shown.

Action OVRVirtualKeyboard.KeyboardHidden ( )
Occurs when keyboard is hidden.

Properties

Collider OVRVirtualKeyboard.Collider
No description available.

InputField OVRVirtualKeyboard.TextCommitField
No description available.

ITextHandler OVRVirtualKeyboard.TextHandler
No description available.

Fields

Transform OVRVirtualKeyboard.leftControllerRootTransform
Configure with the transform representing the left controller input.

Transform OVRVirtualKeyboard.leftControllerDirectTransform
No description available.

Transform OVRVirtualKeyboard.rightControllerRootTransform
Configure with the transform representing the right controller input.

Transform OVRVirtualKeyboard.rightControllerDirectTransform
No description available.

bool OVRVirtualKeyboard.controllerDirectInteraction
Enables the controllers to directly interact with the keyboard.

bool OVRVirtualKeyboard.controllerRayInteraction
Enables the controllers to send ray interactions to the keyboard.

OVRPhysicsRaycaster OVRVirtualKeyboard.controllerRaycaster
Configures the raycast mask used when sending raycast controller input to the keyboard.

OVRHand OVRVirtualKeyboard.handLeft
The OVRHand representing the left hand. Requires the OVRHand to also have an OVRSkeleton.

OVRHand OVRVirtualKeyboard.handRight
The OVRHand representing the right hand. Requires the OVRHand to also have an OVRSkeleton.

bool OVRVirtualKeyboard.handDirectInteraction
Enables tracked hands to directly interact with the keyboard.

bool OVRVirtualKeyboard.handRayInteraction
Enables tracked hands to send ray interactions to the keyboard.

OVRPhysicsRaycaster OVRVirtualKeyboard.handRaycaster
Configures the raycast mask used when sending raycast hand input to the keyboard.

Shader OVRVirtualKeyboard.keyboardModelShader
The shader used to render the keyboard’s glTF materials.

Shader OVRVirtualKeyboard.keyboardModelAlphaBlendShader
The shader used to render the keyboard’s glTF alpha blended materials.

bool OVRVirtualKeyboard.InputEnabled
If false, prevents all keyboard input.

CommitTextUnityEvent OVRVirtualKeyboard.CommitTextEvent
No description available.

UnityEvent OVRVirtualKeyboard.BackspaceEvent
No description available.

UnityEvent OVRVirtualKeyboard.EnterEvent
No description available.

UnityEvent OVRVirtualKeyboard.KeyboardShownEvent
No description available.

UnityEvent OVRVirtualKeyboard.KeyboardHiddenEvent
No description available.

Member Functions

void OVRVirtualKeyboard.UseSuggestedLocation ( KeyboardPosition position )
Updates the keyboard to a reference position.

void OVRVirtualKeyboard.SendVirtualKeyboardRayInput ( Transform inputTransform, InputSource source, bool isPressed, bool useRaycastMask )
Sends a ray input to the keyboard from a given transform. Parameters inputTransform GameObject Transform with the pose and forward orientation of the input ray. source Input source to use (ex. Controller/Hand Left/Right). isPressed If true, will trigger a key press if the ray collides with a keyboard key. useRaycastMask Defaults to true. Will use the configured raycast mask for the given input source.

void OVRVirtualKeyboard.SendVirtualKeyboardRayInput
( Transform inputTransform,
InputSource source,
bool isPressed,
bool useRaycastMask )

Sends a ray input to the keyboard from a given transform.

Parameters

inputTransform

GameObject Transform with the pose and forward orientation of the input ray.

source

Input source to use (ex. Controller/Hand Left/Right).

isPressed

If true, will trigger a key press if the ray collides with a keyboard key.

useRaycastMask

Defaults to true. Will use the configured raycast mask for the given input source.

void OVRVirtualKeyboard.SendVirtualKeyboardDirectInput ( Vector3 position, InputSource source, bool isPressed, Transform interactorRootTransform )
Sends a direct input to the keyboard from a given transform. Parameters position The collision point which is interacting with the keyboard. For example, a hand index finger tip. source The input source to use (ex. Controller/Hand Left/Right). isPressed If the input is triggering a press or not.

void OVRVirtualKeyboard.ChangeTextContext ( string textContext )
Enables custom handling of text context. Use this when changing input fields or if the input text has changed via another script.

void OVRVirtualKeyboard.AutoPopulate ( )
No description available.

Did you find this page helpful?