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

Properties

Collider : Collider [Get]	Signature Collider OVRVirtualKeyboard.Collider
TextCommitField : InputField [Get][Set]	Signature InputField OVRVirtualKeyboard.TextCommitField
TextHandler : ITextHandler [Get][Set]	Signature ITextHandler OVRVirtualKeyboard.TextHandler

Events

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

Methods

AutoPopulate ()	Signature void OVRVirtualKeyboard.AutoPopulate() Returns `void`
ChangeTextContext ( textContext )	Enables custom handling of text context. Use this when changing input fields or if the input text has changed via another script. Signature void OVRVirtualKeyboard.ChangeTextContext(string textContext) Parameters `textContext: string` Returns `void`
SendVirtualKeyboardDirectInput ( position , source , isPressed , interactorRootTransform )	Sends a direct input to the keyboard from a given transform. Signature void OVRVirtualKeyboard.SendVirtualKeyboardDirectInput(Vector3 position, InputSource source, bool isPressed, Transform interactorRootTransform=null) Parameters `position: Vector3` The collision point which is interacting with the keyboard. For example, a hand index finger tip. `source: InputSource` The input source to use (ex. Controller/Hand Left/Right). `isPressed: bool` If the input is triggering a press or not. `interactorRootTransform: Transform` Returns `void`
SendVirtualKeyboardRayInput ( inputTransform , source , isPressed , useRaycastMask )	Sends a ray input to the keyboard from a given transform. Signature void OVRVirtualKeyboard.SendVirtualKeyboardRayInput(Transform inputTransform, InputSource source, bool isPressed, bool useRaycastMask=true) Parameters `inputTransform: Transform` GameObject Transform with the pose and forward orientation of the input ray. `source: InputSource` Input source to use (ex. Controller/Hand Left/Right). `isPressed: bool` If true, will trigger a key press if the ray collides with a keyboard key. `useRaycastMask: bool` Defaults to true. Will use the configured raycast mask for the given input source. Returns `void`
UseSuggestedLocation ( position )	Updates the keyboard to a reference position. Signature void OVRVirtualKeyboard.UseSuggestedLocation(KeyboardPosition position) Parameters `position: KeyboardPosition` Returns `void`

Inner Interface

ITextHandler Interface

Properties

IsFocused : bool [Get]	Signature bool OVRVirtualKeyboard.ITextHandler.IsFocused
OnTextChanged : Action< string > [Get][Set]	Signature Action<string> OVRVirtualKeyboard.ITextHandler.OnTextChanged
SubmitOnEnter : bool [Get]	Signature bool OVRVirtualKeyboard.ITextHandler.SubmitOnEnter
Text : string [Get]	Signature string OVRVirtualKeyboard.ITextHandler.Text

Methods

AppendText ( s )	Signature void OVRVirtualKeyboard.ITextHandler.AppendText(string s) Parameters `s: string` Returns `void`
ApplyBackspace ()	Signature void OVRVirtualKeyboard.ITextHandler.ApplyBackspace() Returns `void`
MoveTextEnd ()	Signature void OVRVirtualKeyboard.ITextHandler.MoveTextEnd() Returns `void`
Submit ()	Signature void OVRVirtualKeyboard.ITextHandler.Submit() Returns `void`

Inner Classes

AbstractTextHandler Class

Extends MonoBehaviour

Implements OVRVirtualKeyboard.ITextHandler

Properties

IsFocused : abstract bool [Get]	Signature abstract bool OVRVirtualKeyboard.AbstractTextHandler.IsFocused
OnTextChanged : abstract Action< string > [Get][Set]	Signature abstract Action<string> OVRVirtualKeyboard.AbstractTextHandler.OnTextChanged
SubmitOnEnter : abstract bool [Get]	Signature abstract bool OVRVirtualKeyboard.AbstractTextHandler.SubmitOnEnter
Text : abstract string [Get]	Signature abstract string OVRVirtualKeyboard.AbstractTextHandler.Text

Methods

AppendText ( s )	Signature abstract void OVRVirtualKeyboard.AbstractTextHandler.AppendText(string s) Parameters `s: string` Returns `abstract void`
ApplyBackspace ()	Signature abstract void OVRVirtualKeyboard.AbstractTextHandler.ApplyBackspace() Returns `abstract void`
MoveTextEnd ()	Signature abstract void OVRVirtualKeyboard.AbstractTextHandler.MoveTextEnd() Returns `abstract void`
Submit ()	Signature abstract void OVRVirtualKeyboard.AbstractTextHandler.Submit() Returns `abstract void`

CommitTextUnityEvent Class

InteractorRootTransformOverride Class

Methods

Enqueue ( interactorRootTransform , interactorRootPose )	Signature void OVRVirtualKeyboard.InteractorRootTransformOverride.Enqueue(Transform interactorRootTransform, OVRPlugin.Posef interactorRootPose) Parameters `interactorRootTransform: Transform` `interactorRootPose: OVRPlugin.Posef` Returns `void`
LateApply ( coroutineRunner )	Signature void OVRVirtualKeyboard.InteractorRootTransformOverride.LateApply(MonoBehaviour coroutineRunner) Parameters `coroutineRunner: MonoBehaviour` Returns `void`
Reset ()	Signature void OVRVirtualKeyboard.InteractorRootTransformOverride.Reset() Returns `void`

WaitUntilKeyboardVisible Class

Extends CustomYieldInstruction

Keyboard initialization is async so this yield instruction is available for use in coroutines that an action performed once the keyboard is visible.

Constructors

WaitUntilKeyboardVisible ( keyboard )

Signature

OVRVirtualKeyboard.WaitUntilKeyboardVisible.WaitUntilKeyboardVisible(OVRVirtualKeyboard keyboard)

Parameters

keyboard: OVRVirtualKeyboard

Properties

keepWaiting : override bool

[Get]

Signature

override bool OVRVirtualKeyboard.WaitUntilKeyboardVisible.keepWaiting

Inner Enums

KeyboardPosition Enum

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

Far uses raycasting to type. Near uses direct touch to type. If set to Far or Near, the keyboard position is runtime controlled, so the Transform component will be locked.