API reference

OVRInputModule Class

Extends PointerInputModule

VR extension of PointerInputModule which supports gaze and controller pointing.

Constructors

OVRInputModule ()

Signature

UnityEngine.EventSystems.OVRInputModule.OVRInputModule()

Protected Fields

m_VRRayPointerData : Dictionary< int, OVRPointerEventData >

Signature

Dictionary<int, OVRPointerEventData> UnityEngine.EventSystems.OVRInputModule.m_VRRayPointerData

Fields

activeGraphicRaycaster : OVRRaycaster	Signature OVRRaycaster UnityEngine.EventSystems.OVRInputModule.activeGraphicRaycaster
angleDragThreshold : float	Signature float UnityEngine.EventSystems.OVRInputModule.angleDragThreshold
gazeClickKey : KeyCode	Signature KeyCode UnityEngine.EventSystems.OVRInputModule.gazeClickKey
InvertSwipeXAxis : bool	Signature bool UnityEngine.EventSystems.OVRInputModule.InvertSwipeXAxis
joyPadClickButton : OVRInput.Button	Signature OVRInput.Button UnityEngine.EventSystems.OVRInputModule.joyPadClickButton
m_Cursor : OVRCursor	Signature OVRCursor UnityEngine.EventSystems.OVRInputModule.m_Cursor
performSphereCastForGazepointer : bool	Signature bool UnityEngine.EventSystems.OVRInputModule.performSphereCastForGazepointer
rayTransform : Transform	Signature Transform UnityEngine.EventSystems.OVRInputModule.rayTransform
rightStickDeadZone : float	Signature float UnityEngine.EventSystems.OVRInputModule.rightStickDeadZone
swipeDragScale : float	Signature float UnityEngine.EventSystems.OVRInputModule.swipeDragScale
swipeDragThreshold : float	Signature float UnityEngine.EventSystems.OVRInputModule.swipeDragThreshold
useRightStickScroll : bool	Signature bool UnityEngine.EventSystems.OVRInputModule.useRightStickScroll
useSwipeScroll : bool	Signature bool UnityEngine.EventSystems.OVRInputModule.useSwipeScroll

Properties

allowActivationOnMobileDevice : bool [Get][Set]	Signature bool UnityEngine.EventSystems.OVRInputModule.allowActivationOnMobileDevice
cancelButton : string [Get][Set]	Signature string UnityEngine.EventSystems.OVRInputModule.cancelButton
horizontalAxis : string [Get][Set]	Name of the horizontal axis for movement (if axis events are used). Signature string UnityEngine.EventSystems.OVRInputModule.horizontalAxis
inputActionsPerSecond : float [Get][Set]	Signature float UnityEngine.EventSystems.OVRInputModule.inputActionsPerSecond
inputMode : InputMode [Get]	Signature InputMode UnityEngine.EventSystems.OVRInputModule.inputMode
instance : OVRInputModule [Get]	Signature OVRInputModule UnityEngine.EventSystems.OVRInputModule.instance
submitButton : string [Get][Set]	Signature string UnityEngine.EventSystems.OVRInputModule.submitButton
verticalAxis : string [Get][Set]	Name of the vertical axis for movement (if axis events are used). Signature string UnityEngine.EventSystems.OVRInputModule.verticalAxis

Protected Methods

Awake ()	Signature override void UnityEngine.EventSystems.OVRInputModule.Awake() Returns `override void`
ClearSelection ()	Clear pointer state for both types of pointer. Signature new void UnityEngine.EventSystems.OVRInputModule.ClearSelection() Returns `new void`
CopyFromTo ( from , to )	Convenience function for cloning PointerEventData. Signature void UnityEngine.EventSystems.OVRInputModule.CopyFromTo(OVRPointerEventData @from, OVRPointerEventData @to) Parameters `from: OVRPointerEventData @` Copy this value `to: OVRPointerEventData @` to this object Returns `void`
CopyFromTo ( from , to )	Convenience function for cloning PointerEventData. Signature new void UnityEngine.EventSystems.OVRInputModule.CopyFromTo(PointerEventData @from, PointerEventData @to) Parameters `from: PointerEventData @` Copy this value `to: PointerEventData @` to this object Returns `new void`
GetCanvasPointerData ()	Get state for pointer which is a pointer moving in world space across the surface of a world space canvas. Signature MouseState UnityEngine.EventSystems.OVRInputModule.GetCanvasPointerData() Returns `MouseState`
GetExtraScrollDelta ()	Get extra scroll delta from gamepad. Signature Vector2 UnityEngine.EventSystems.OVRInputModule.GetExtraScrollDelta() Returns `Vector2`
GetGazeButtonState ()	Get state of button corresponding to gaze pointer. Signature virtual PointerEventData.FramePressState UnityEngine.EventSystems.OVRInputModule.GetGazeButtonState() Returns `PointerEventData.FramePressState`
GetMouseStateFromInputSource ( inputSource , id )	Handle inputs from hands and controllers and parse them in a way unity UI can understand. Signature virtual MouseState UnityEngine.EventSystems.OVRInputModule.GetMouseStateFromInputSource(InputSource inputSource, int id) Parameters `inputSource: InputSource` `id: int` Returns `MouseState`
GetMouseStateFromRaycast ( rayOrigin )	State for a pointer controlled by a world space ray. E.g. gaze pointer Signature virtual MouseState UnityEngine.EventSystems.OVRInputModule.GetMouseStateFromRaycast(Transform rayOrigin) Parameters `rayOrigin: Transform` Returns `MouseState`
GetPointerData ( id , data , create )	Signature bool UnityEngine.EventSystems.OVRInputModule.GetPointerData(int id, out OVRPointerEventData data, bool create) Parameters `id: int` `data: out OVRPointerEventData` `create: bool` Returns `bool`
OnDestroy ()	Signature override void UnityEngine.EventSystems.OVRInputModule.OnDestroy() Returns `override void`
ProcessDrag ( 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 Signature override void UnityEngine.EventSystems.OVRInputModule.ProcessDrag(PointerEventData pointerEvent) Parameters `pointerEvent: PointerEventData` Returns `override void`
SwipeAdjustedPosition ( originalPosition , pointerEvent )	Signature Vector2 UnityEngine.EventSystems.OVRInputModule.SwipeAdjustedPosition(Vector2 originalPosition, PointerEventData pointerEvent) Parameters `originalPosition: Vector2` `pointerEvent: PointerEventData` Returns `Vector2`

Methods

ActivateModule ()	Signature override void UnityEngine.EventSystems.OVRInputModule.ActivateModule() Returns `override void`
DeactivateModule ()	Signature override void UnityEngine.EventSystems.OVRInputModule.DeactivateModule() Returns `override void`
IsModuleSupported ()	Signature override bool UnityEngine.EventSystems.OVRInputModule.IsModuleSupported() Returns `override bool`
Process ()	Process this InputModule. Same as the StandaloneInputModule version, except that it calls ProcessMouseEvent twice, once for gaze pointers, and once for mouse pointers. Signature override void UnityEngine.EventSystems.OVRInputModule.Process() Returns `override void`
ShouldActivateModule ()	Signature override bool UnityEngine.EventSystems.OVRInputModule.ShouldActivateModule() Returns `override bool`
UpdateModule ()	Signature override void UnityEngine.EventSystems.OVRInputModule.UpdateModule() Returns `override void`

Static Methods

TrackInputSource ( hand )	Signature static void UnityEngine.EventSystems.OVRInputModule.TrackInputSource(InputSource hand) Parameters `hand: InputSource` Returns `void`
UntrackInputSource ( hand )	Signature static void UnityEngine.EventSystems.OVRInputModule.UntrackInputSource(InputSource hand) Parameters `hand: InputSource` Returns `void`

Inner Interface

InputSource Interface

Represents a source for UI interactions, e.g.

hands / controllers.

Methods

GetHand ()	Signature OVRPlugin.Hand UnityEngine.EventSystems.OVRInputModule.InputSource.GetHand() Returns `OVRPlugin.Hand`
GetPointerRayTransform ()	Signature Transform UnityEngine.EventSystems.OVRInputModule.InputSource.GetPointerRayTransform() Returns `Transform`
IsActive ()	Signature bool UnityEngine.EventSystems.OVRInputModule.InputSource.IsActive() Returns `bool`
IsPressed ()	Signature bool UnityEngine.EventSystems.OVRInputModule.InputSource.IsPressed() Returns `bool`
IsReleased ()	Signature bool UnityEngine.EventSystems.OVRInputModule.InputSource.IsReleased() Returns `bool`
IsValid ()	Signature bool UnityEngine.EventSystems.OVRInputModule.InputSource.IsValid() Returns `bool`
UpdatePointerRay ( rayData )	Signature void UnityEngine.EventSystems.OVRInputModule.InputSource.UpdatePointerRay(OVRInputRayData rayData) Parameters `rayData: OVRInputRayData` Returns `void`