Skip to main content

Class: Mouse

Defined in: livelink.clients/livelink.js/sources/inputs/Mouse.ts:10

Extends​

  • InputDevice

Methods​

enable()​

enable(): void;

Defined in: livelink.clients/livelink.js/sources/inputs/InputDevice.ts:10

Enable the input device. If the device is already enabled, this method does nothing.

Returns​

void

Inherited from​

InputDevice.enable;

disable()​

disable(): void;

Defined in: livelink.clients/livelink.js/sources/inputs/InputDevice.ts:22

Disable the input device. If the device is already disabled, this method does nothing.

Returns​

void

Inherited from​

InputDevice.disable;

enableOnViewport()​

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

Defined in: livelink.clients/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​

ParameterTypeDescription
params{ viewport: Viewport; }-
params.viewportViewportThe viewport to enable mouse input on.

Returns​

void

disableFromViewport()​

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

Defined in: livelink.clients/livelink.js/sources/inputs/Mouse.ts:99

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​

ParameterTypeDescription
params{ viewport: Viewport; }-
params.viewportViewportThe viewport to disable mouse input on.

Returns​

void

_onEnable()​

protected _onEnable(): boolean;

Defined in: livelink.clients/livelink.js/sources/inputs/Mouse.ts:123

Returns​

boolean

Overrides​

InputDevice._onEnable;

_onDisable()​

protected _onDisable(): void;

Defined in: livelink.clients/livelink.js/sources/inputs/Mouse.ts:130

Returns​

void

Overrides​

InputDevice._onDisable;