Class: Mouse

Defined in: livelink.js/sources/inputs/Mouse.ts:8

Methods

enableOnViewport()

enableOnViewport(params: {
  viewport: Viewport;
 }): void

Defined in: livelink.js/sources/inputs/Mouse.ts:58

Enables mouse input on the given viewport. Increases the reference count of the viewport usage. Each call to this method should be matched with a call to release.

Parameters

Parameter	Type	Description
params	{ viewport: Viewport; }
params.viewport	Viewport	The viewport to enable mouse input on.

Returns

void

---

disableFromViewport()

disableFromViewport(params: {
  viewport: Viewport;
 }): void

Defined in: livelink.js/sources/inputs/Mouse.ts:93

Decreases the reference count of the viewport usage. Each call to this method should be matched with a call to setup. If the reference count reaches 0, the mouse input is disabled for the viewport.

Parameters

Parameter	Type	Description
params	{ viewport: Viewport; }
params.viewport	Viewport	The viewport to disable mouse input on.

Returns

void