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

Properties

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

Events

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

Methods

AutoPopulate ()	Signature void 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 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 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 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 UseSuggestedLocation(KeyboardPosition position) Parameters `position: KeyboardPosition` Returns `void`

Inner Interface

ITextHandler Interface

Properties

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

Methods

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

Inner Classes

AbstractTextHandler Class

Extends MonoBehaviour

Implements OVRVirtualKeyboard.ITextHandler

Properties

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

Methods

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

CommitTextUnityEvent Class

InteractorRootTransformOverride Class

Methods

Enqueue ( interactorRootTransform , interactorRootPose )	Signature void Enqueue(Transform interactorRootTransform, OVRPlugin.Posef interactorRootPose) Parameters `interactorRootTransform: Transform` `interactorRootPose: OVRPlugin.Posef` Returns `void`
LateApply ( coroutineRunner )	Signature void LateApply(MonoBehaviour coroutineRunner) Parameters `coroutineRunner: MonoBehaviour` Returns `void`
Reset ()	Signature void 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

WaitUntilKeyboardVisible(OVRVirtualKeyboard keyboard)

Parameters

keyboard: OVRVirtualKeyboard

Properties

keepWaiting : override bool

[Get]

Signature

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