API reference

PointableCanvasModule Class

Extends PointerInputModule

PointableCanvasModule is a context-like object which exists in the scene and handles routing for certain types of PointerEvents, translating them into Unity pointer events which can be routed to and consumed by Unity Canvases.

PointableCanvas requires that the scene contain a PointableCanvasModule.

Protected Fields

_started : bool

Signature

bool _started

Properties

ExclusiveMode : bool

[Get][Set]

If true, this module will disable other input modules in the event system and will be the only input module used in the scene.

Signature

bool ExclusiveMode

Events

WhenSelectableHovered : Action< PointableCanvasEventArgs >	Global event invoked in response to a PointerEventType.Hover on an IPointableCanvas. Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process. Signature Action<PointableCanvasEventArgs> WhenSelectableHovered
WhenSelectableUnhovered : Action< PointableCanvasEventArgs >	Global event invoked in response to a PointerEventType.Unhover on an IPointableCanvas. Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process. Signature Action<PointableCanvasEventArgs> WhenSelectableUnhovered
WhenSelected : Action< PointableCanvasEventArgs >	Global event invoked in response to a PointerEventType.Select on an IPointableCanvas. Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process. Signature Action<PointableCanvasEventArgs> WhenSelected
WhenUnselected : Action< PointableCanvasEventArgs >	Global event invoked in response to a PointerEventType.Unselect on an IPointableCanvas. Though this event itself is static, it is invoked by the PointableCanvasModule instance in the scene as part of Process. Signature Action<PointableCanvasEventArgs> WhenUnselected

Protected Methods

Awake ()	Signature override void Awake() Returns `override void`
OnDestroy ()	Signature override void OnDestroy() Returns `override void`
OnDisable ()	Signature override void OnDisable() Returns `override void`
OnEnable ()	Signature override void 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 ProcessDrag(PointerEventData pointerEvent) Parameters `pointerEvent: PointerEventData` Returns `override void`
Start ()	Signature override void 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 UpdatePointerEventData(PointerEventData pointerEvent, bool pressed, bool released) Parameters `pointerEvent: PointerEventData` `pressed: bool` `released: bool` Returns `void`

Methods

Process ()	This is an internal API which is invoked to process input. This overrides the Process() method of Unity's BaseInputModule, from which PointableCanvasModule is descended, and should not be invoked manually. Signature override void Process() Returns `override void`
UpdateModule ()	This is an internal API which is invoked to update the PointableCanvasModule. This overrides the UpdateModule() method of Unity's BaseInputModule, from which PointableCanvasModule is descended, and should not be invoked directly. Signature override void UpdateModule() Returns `override void`

Protected Static Methods

FindFirstRaycastWithinCanvas ( candidates , canvas )

Signature

static RaycastResult 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 ShouldStartDrag(Vector2 pressPos, Vector2 currentPos, float threshold, bool useDragThreshold)

Parameters

pressPos: Vector2

currentPos: Vector2

threshold: float

useDragThreshold: bool

Returns

bool

Static Methods

RegisterPointableCanvas ( pointerCanvas )	Registers an IPointableCanvas with the PointableCanvasModule in the scene so that its PointerEvents can be correctly handled, converted, and forwarded. Signature static void RegisterPointableCanvas(IPointableCanvas pointerCanvas) Parameters `pointerCanvas: IPointableCanvas` The IPointableCanvas to register Returns `void`
UnregisterPointableCanvas ( pointerCanvas )	Unregisters an IPointableCanvas with the PointableCanvasModule in the scene. PointerEvents from that canvas will no longer be propagated to the Unity Canvas. Signature static void UnregisterPointableCanvas(IPointableCanvas pointerCanvas) Parameters `pointerCanvas: IPointableCanvas` The IPointableCanvas to unregister Returns `void`