InteractorStyleRemoteMouse

Source (.js)Source (.d.ts)

Introduction

Interactor style that does not act on the local camera but re-emits mouse, wheel and gesture interactions as events meant to be forwarded to a remote renderer.

Methods

getRemoteEventAddOn

Gets the extra fields merged into every forwarded event.

getSendMouseMove

Gets whether mouse moves are forwarded even when no button is pressed.

getThrottleDelay

Gets the minimum delay, in milliseconds, between two forwarded mouse moves.

getWheelThrottleDelay

Gets the minimum delay, in milliseconds, between two forwarded wheel events. Zero disables throttling.

handleLeftButtonPress

Argument	Type	Required	Description
callData		Yes	event data

handleLeftButtonRelease

Argument	Type	Required	Description
callData		Yes	event data

handleMiddleButtonPress

Argument	Type	Required	Description
callData		Yes	event data

handleMiddleButtonRelease

Argument	Type	Required	Description
callData		Yes	event data

handleMouseMove

Argument	Type	Required	Description
callData		Yes	event data

handleMouseWheel

Argument	Type	Required	Description
callData		Yes	event data

handlePan

Argument	Type	Required	Description
callData		Yes	event data

handlePinch

Argument	Type	Required	Description
callData		Yes	event data

handleRightButtonPress

Argument	Type	Required	Description
callData		Yes	event data

handleRightButtonRelease

Argument	Type	Required	Description
callData		Yes	event data

handleRotate

Argument	Type	Required	Description
callData		Yes	event data

handleStartMouseWheel

Argument	Type	Required	Description
callData		Yes	event data

handleStartPan

Argument	Type	Required	Description
callData		Yes	event data

handleStartPinch

Argument	Type	Required	Description
callData		Yes	event data

handleStartRotate

Argument	Type	Required	Description
callData		Yes	event data

onButtonDown

Handles a button down event.

Argument	Type	Required	Description
button		Yes	which button
callData		Yes	event data

onButtonUp

Handles a button up event.

Argument	Type	Required	Description
button		Yes	which button
callData		Yes	event data

setRemoteEventAddOn

Sets the extra fields merged into every forwarded event.

Argument	Type	Required	Description
remoteEventAddOn		Yes

setSendMouseMove

Sets whether mouse moves are forwarded even when no button is pressed.

Argument	Type	Required	Description
sendMouseMove		Yes

setThrottleDelay

Sets the minimum delay, in milliseconds, between two forwarded mouse moves.

Argument	Type	Required	Description
throttleDelay		Yes

setWheelThrottleDelay

Sets the minimum delay, in milliseconds, between two forwarded wheel events. Zero disables throttling.

Argument	Type	Required	Description
wheelThrottleDelay		Yes