Skip to main content

Mouse

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

Methods

enableOnViewport()

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

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

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

ParameterType
__namedParameters{ viewport: Viewport; }
__namedParameters.viewportViewport

Returns

void


disableFromViewport()

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

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

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

ParameterType
__namedParameters{ viewport: Viewport; }
__namedParameters.viewportViewport

Returns

void