API reference
API reference
Select your platform
No SDKs available
No versions available

PointableCanvasModule Class

IPointerInteractableModule manages all InteractableCanvas events in the scene and translates them into pointer events for Unity Canvas UIs.
Oculus::Interaction::PointableCanvasModule extends PointerInputModule.

Overview

Events

static Action< PointableCanvasEventArgs >
static Action< PointableCanvasEventArgs >
static Action< PointableCanvasEventArgs >
static Action< PointableCanvasEventArgs >

Properties

static PointableCanvasModule

Object Data

bool

Static Public Member Functions

static void
static void

Object Data

override void
Awake ( )
override void
override void
Start ( )
override void
override void
void
UpdatePointerEventData
( PointerEventData pointerEvent,
bool pressed,
bool released )
This method is based on ProcessTouchPoint in StandaloneInputModule, but is instead used for Pointer events.
override void
ProcessDrag
( PointerEventData pointerEvent )
Override of PointerInputModule's ProcessDrag to allow using the initial press position for drag begin.

Object Data

static RaycastResult
FindFirstRaycastWithinCanvas
( List< RaycastResult > candidates,
Canvas canvas )
static bool
ShouldStartDrag
( Vector2 pressPos,
Vector2 currentPos,
float threshold,
bool useDragThreshold )
Used in PointerInputModule's ProcessDrag implementation.

Public Member Functions

override void
Process ( )

Details

Events

Action<PointableCanvasEventArgs> Oculus.Interaction.PointableCanvasModule.WhenSelected ( )
No description available.
Action<PointableCanvasEventArgs> Oculus.Interaction.PointableCanvasModule.WhenUnselected ( )
No description available.
Action<PointableCanvasEventArgs> Oculus.Interaction.PointableCanvasModule.WhenSelectableHovered ( )
No description available.
Action<PointableCanvasEventArgs> Oculus.Interaction.PointableCanvasModule.WhenSelectableUnhovered ( )
No description available.

Properties

PointableCanvasModule Oculus.Interaction.PointableCanvasModule.Instance
No description available.

Object Data

bool Oculus.Interaction.PointableCanvasModule._started
No description available.

Static Member Functions

static void Oculus.Interaction.PointableCanvasModule.RegisterPointableCanvas
( IPointableCanvas pointerCanvas )
No description available.
static void Oculus.Interaction.PointableCanvasModule.UnregisterPointableCanvas
( IPointableCanvas pointerCanvas )
No description available.

Object Data

override void Oculus.Interaction.PointableCanvasModule.Awake ( )
No description available.
override void Oculus.Interaction.PointableCanvasModule.OnDestroy ( )
No description available.
override void Oculus.Interaction.PointableCanvasModule.Start ( )
No description available.
override void Oculus.Interaction.PointableCanvasModule.OnEnable ( )
No description available.
override void Oculus.Interaction.PointableCanvasModule.OnDisable ( )
No description available.
void Oculus.Interaction.PointableCanvasModule.UpdatePointerEventData
( PointerEventData pointerEvent,
bool pressed,
bool released )
This method is based on ProcessTouchPoint in StandaloneInputModule, but is instead used for Pointer events.
override void Oculus.Interaction.PointableCanvasModule.ProcessDrag
( PointerEventData 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.

Object Data

static RaycastResult Oculus.Interaction.PointableCanvasModule.FindFirstRaycastWithinCanvas
( List< RaycastResult > candidates,
Canvas canvas )
No description available.
static bool Oculus.Interaction.PointableCanvasModule.ShouldStartDrag
( Vector2 pressPos,
Vector2 currentPos,
float threshold,
bool 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.

Member Functions

override void Oculus.Interaction.PointableCanvasModule.Process ( )
No description available.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta