API reference
OVRInputModule Class
VR extension of PointerInputModule which supports gaze and controller pointing.
UnityEngine::EventSystems::OVRInputModule extends PointerInputModule.
Overview
Public Types
enum | InputMode { } |
Data Fields
Transform | rayTransform[Get] |
m_Cursor[Get] | |
joyPadClickButton[Get] | |
KeyCode | gazeClickKey[Get] |
bool | |
bool | useRightStickScroll[Get] |
float | rightStickDeadZone[Get] |
bool | useSwipeScroll[Get] |
float | swipeDragThreshold[Get] |
float | swipeDragScale[Get] |
bool | InvertSwipeXAxis[Get] |
float | angleDragThreshold[Get] |
Properties
InputMode | inputMode[Get] |
bool | |
float | |
string | horizontalAxis[Get] Name of the horizontal axis for movement (if axis events are used). |
string | verticalAxis[Get] Name of the vertical axis for movement (if axis events are used). |
string | submitButton[Get] |
string | cancelButton[Get] |
static OVRInputModule | instance[Get] |
Object Data
Dictionary< int, OVRPointerEventData > | m_VRRayPointerData[Get] |
Object Data
OVRInputModule ( ) | |
override void | Awake ( ) |
void | Convenience function for cloning PointerEventData. |
new void | Convenience function for cloning PointerEventData. |
bool | |
new void | ClearSelection ( ) Clear pointer state for both types of pointer. |
MouseState | Handle inputs from hands and controllers and parse them in a way unity UI can understand. |
MouseState | GetMouseStateFromRaycast ( Transform rayOrigin ) State for a pointer controlled by a world space ray. |
MouseState | Get state for pointer which is a pointer moving in world space across the surface of a world space canvas. |
Vector2 | |
override void | ProcessDrag ( PointerEventData pointerEvent ) Exactly the same as the code from PointerInputModule, except that we call our own IsPointerMoving. |
PointerEventData.FramePressState | Get state of button corresponding to gaze pointer. |
Vector2 | Get extra scroll delta from gamepad. |
override void | OnDestroy ( ) |
Public Member Functions
override void | UpdateModule ( ) |
override bool | |
override bool | |
override void | ActivateModule ( ) |
override void | DeactivateModule ( ) |
override void | Process ( ) Process this InputModule. |
Static Public Member Functions
static void | TrackInputSource ( InputSource hand ) |
static void | UntrackInputSource ( InputSource hand ) |
Details
Member Enumerations
enum UnityEngine::EventSystems::OVRInputModule.InputMode
Enumerator
Mouse | |
Buttons |
Fields
| Transform UnityEngine.EventSystems.OVRInputModule.rayTransform |
|---|
No description available.
|
| OVRCursor UnityEngine.EventSystems.OVRInputModule.m_Cursor |
|---|
No description available.
|
| OVRInput.Button UnityEngine.EventSystems.OVRInputModule.joyPadClickButton |
|---|
No description available.
|
| KeyCode UnityEngine.EventSystems.OVRInputModule.gazeClickKey |
|---|
No description available.
|
| bool UnityEngine.EventSystems.OVRInputModule.performSphereCastForGazepointer |
|---|
No description available.
|
| bool UnityEngine.EventSystems.OVRInputModule.useRightStickScroll |
|---|
No description available.
|
| float UnityEngine.EventSystems.OVRInputModule.rightStickDeadZone |
|---|
No description available.
|
| bool UnityEngine.EventSystems.OVRInputModule.useSwipeScroll |
|---|
No description available.
|
| float UnityEngine.EventSystems.OVRInputModule.swipeDragThreshold |
|---|
No description available.
|
| float UnityEngine.EventSystems.OVRInputModule.swipeDragScale |
|---|
No description available.
|
| bool UnityEngine.EventSystems.OVRInputModule.InvertSwipeXAxis |
|---|
No description available.
|
| OVRRaycaster UnityEngine.EventSystems.OVRInputModule.activeGraphicRaycaster |
|---|
No description available.
|
| float UnityEngine.EventSystems.OVRInputModule.angleDragThreshold |
|---|
No description available.
|
Properties
| InputMode UnityEngine.EventSystems.OVRInputModule.inputMode |
|---|
No description available.
|
| bool UnityEngine.EventSystems.OVRInputModule.allowActivationOnMobileDevice |
|---|
No description available.
|
| float UnityEngine.EventSystems.OVRInputModule.inputActionsPerSecond |
|---|
No description available.
|
| string UnityEngine.EventSystems.OVRInputModule.horizontalAxis |
|---|
Name of the horizontal axis for movement (if axis events are used). |
| string UnityEngine.EventSystems.OVRInputModule.verticalAxis |
|---|
Name of the vertical axis for movement (if axis events are used). |
| string UnityEngine.EventSystems.OVRInputModule.submitButton |
|---|
No description available.
|
| string UnityEngine.EventSystems.OVRInputModule.cancelButton |
|---|
No description available.
|
| OVRInputModule UnityEngine.EventSystems.OVRInputModule.instance |
|---|
No description available.
|
Object Data
| Dictionary<int, OVRPointerEventData> UnityEngine.EventSystems.OVRInputModule.m_VRRayPointerData |
|---|
No description available.
|
Object Data
| UnityEngine.EventSystems.OVRInputModule.OVRInputModule ( ) |
|---|
No description available.
|
| override void UnityEngine.EventSystems.OVRInputModule.Awake ( ) |
|---|
No description available.
|
| void UnityEngine.EventSystems.OVRInputModule.CopyFromTo ( OVRPointerEventData @ from, OVRPointerEventData @ to ) |
|---|
Convenience function for cloning PointerEventData. Parameters from Copy this value toto this object |
| new void UnityEngine.EventSystems.OVRInputModule.CopyFromTo ( PointerEventData @ from, PointerEventData @ to ) |
|---|
Convenience function for cloning PointerEventData. Parameters from Copy this value toto this object |
| bool UnityEngine.EventSystems.OVRInputModule.GetPointerData ( int id, out OVRPointerEventData data, bool create ) |
|---|
No description available.
|
| new void UnityEngine.EventSystems.OVRInputModule.ClearSelection ( ) |
|---|
Clear pointer state for both types of pointer. |
| virtual MouseState UnityEngine.EventSystems.OVRInputModule.GetMouseStateFromInputSource ( InputSource inputSource, int id ) |
|---|
Handle inputs from hands and controllers and parse them in a way unity UI can understand. Returns |
| virtual MouseState UnityEngine.EventSystems.OVRInputModule.GetMouseStateFromRaycast ( Transform rayOrigin ) |
|---|
State for a pointer controlled by a world space ray. E.g. gaze pointer Returns |
| MouseState UnityEngine.EventSystems.OVRInputModule.GetCanvasPointerData ( ) |
|---|
Get state for pointer which is a pointer moving in world space across the surface of a world space canvas. Returns |
| Vector2 UnityEngine.EventSystems.OVRInputModule.SwipeAdjustedPosition ( Vector2 originalPosition, PointerEventData pointerEvent ) |
|---|
No description available.
|
| override void UnityEngine.EventSystems.OVRInputModule.ProcessDrag ( PointerEventData pointerEvent ) |
|---|
Exactly the same as the code from PointerInputModule, except that we call our own IsPointerMoving. This would also not be necessary if PointerEventData.IsPointerMoving was virtual Parameters pointerEvent |
| virtual PointerEventData.FramePressState UnityEngine.EventSystems.OVRInputModule.GetGazeButtonState ( ) |
|---|
Get state of button corresponding to gaze pointer. Returns |
| Vector2 UnityEngine.EventSystems.OVRInputModule.GetExtraScrollDelta ( ) |
|---|
Get extra scroll delta from gamepad. |
| override void UnityEngine.EventSystems.OVRInputModule.OnDestroy ( ) |
|---|
No description available.
|
Member Functions
| override void UnityEngine.EventSystems.OVRInputModule.UpdateModule ( ) |
|---|
No description available.
|
| override bool UnityEngine.EventSystems.OVRInputModule.IsModuleSupported ( ) |
|---|
No description available.
|
| override bool UnityEngine.EventSystems.OVRInputModule.ShouldActivateModule ( ) |
|---|
No description available.
|
| override void UnityEngine.EventSystems.OVRInputModule.ActivateModule ( ) |
|---|
No description available.
|
| override void UnityEngine.EventSystems.OVRInputModule.DeactivateModule ( ) |
|---|
No description available.
|
| override void UnityEngine.EventSystems.OVRInputModule.Process ( ) |
|---|
Process this InputModule. Same as the StandaloneInputModule version, except that it calls ProcessMouseEvent twice, once for gaze pointers, and once for mouse pointers. |
Static Member Functions
| static void UnityEngine.EventSystems.OVRInputModule.TrackInputSource ( InputSource hand ) |
|---|
No description available.
|
| static void UnityEngine.EventSystems.OVRInputModule.UntrackInputSource ( InputSource hand ) |
|---|
No description available.
|
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta