API reference

PointableCanvasModule Class

Extends PointerInputModule

IPointerInteractableModule manages all InteractableCanvas events in the scene and translates them into pointer events for Unity Canvas UIs.

Protected Fields

_started : bool

Signature

bool Oculus.Interaction.PointableCanvasModule._started

Properties

ExclusiveMode : bool

[Get][Set]

Signature

bool Oculus.Interaction.PointableCanvasModule.ExclusiveMode

Events

WhenSelectableHovered : Action< PointableCanvasEventArgs >	Signature Action<PointableCanvasEventArgs> Oculus.Interaction.PointableCanvasModule.WhenSelectableHovered
WhenSelectableUnhovered : Action< PointableCanvasEventArgs >	Signature Action<PointableCanvasEventArgs> Oculus.Interaction.PointableCanvasModule.WhenSelectableUnhovered
WhenSelected : Action< PointableCanvasEventArgs >	Signature Action<PointableCanvasEventArgs> Oculus.Interaction.PointableCanvasModule.WhenSelected
WhenUnselected : Action< PointableCanvasEventArgs >	Signature Action<PointableCanvasEventArgs> Oculus.Interaction.PointableCanvasModule.WhenUnselected

Protected Methods

Awake ()	Signature override void Oculus.Interaction.PointableCanvasModule.Awake() Returns `override void`
OnDestroy ()	Signature override void Oculus.Interaction.PointableCanvasModule.OnDestroy() Returns `override void`
OnDisable ()	Signature override void Oculus.Interaction.PointableCanvasModule.OnDisable() Returns `override void`
OnEnable ()	Signature override void Oculus.Interaction.PointableCanvasModule.OnEnable() Returns `override void`
ProcessDrag ( pointerEvent )	Override of PointerInputModule's ProcessDrag to allow using the initial press position for drag begin. Set _useInitialPressPositionForDrag to false if you prefer the default behaviour of PointerInputModule. Signature override void Oculus.Interaction.PointableCanvasModule.ProcessDrag(PointerEventData pointerEvent) Parameters `pointerEvent: PointerEventData` Returns `override void`
Start ()	Signature override void Oculus.Interaction.PointableCanvasModule.Start() Returns `override void`
UpdatePointerEventData ( pointerEvent , pressed , released )	This method is based on ProcessTouchPoint in StandaloneInputModule, but is instead used for Pointer events. Signature void Oculus.Interaction.PointableCanvasModule.UpdatePointerEventData(PointerEventData pointerEvent, bool pressed, bool released) Parameters `pointerEvent: PointerEventData` `pressed: bool` `released: bool` Returns `void`

Methods

Process ()	Signature override void Oculus.Interaction.PointableCanvasModule.Process() Returns `override void`
UpdateModule ()	Signature override void Oculus.Interaction.PointableCanvasModule.UpdateModule() Returns `override void`

Protected Static Methods

FindFirstRaycastWithinCanvas ( candidates , canvas )

Signature

static RaycastResult Oculus.Interaction.PointableCanvasModule.FindFirstRaycastWithinCanvas(List< RaycastResult > candidates, Canvas canvas)

Parameters

candidates: List< RaycastResult >

canvas: Canvas

Returns

RaycastResult

ShouldStartDrag ( pressPos , currentPos , threshold , useDragThreshold )

Used in PointerInputModule's ProcessDrag implementation.

Brought into this subclass with a protected signature (as opposed to the parent's private signature) to be used in this subclass's overridden ProcessDrag.

Signature

static bool Oculus.Interaction.PointableCanvasModule.ShouldStartDrag(Vector2 pressPos, Vector2 currentPos, float threshold, bool useDragThreshold)

Parameters

pressPos: Vector2

currentPos: Vector2

threshold: float

useDragThreshold: bool

Returns

bool

Static Methods

RegisterPointableCanvas ( pointerCanvas )	Signature static void Oculus.Interaction.PointableCanvasModule.RegisterPointableCanvas(IPointableCanvas pointerCanvas) Parameters `pointerCanvas: IPointableCanvas` Returns `void`
UnregisterPointableCanvas ( pointerCanvas )	Signature static void Oculus.Interaction.PointableCanvasModule.UnregisterPointableCanvas(IPointableCanvas pointerCanvas) Parameters `pointerCanvas: IPointableCanvas` Returns `void`