Skip to content

MouseRollHandler

Defined in: src/ui/handler/mouse.ts:23

MouseRollHandler allows the user to roll the camera by holding Ctrl, right-clicking and dragging

Extends

  • DragMoveHandler<DragRollResult, MouseEvent>

Methods

isActive()

isActive(): boolean

Defined in: src/ui/handler_manager.ts:49

This is used to indicate if the handler is currently active or not. In case a handler is active, it will block other handlers from getting the relevant events. There is an allow list of handlers that can be active at the same time, which is configured when adding a handler.

Returns

boolean

Inherited from

DragMoveHandler.isActive


reset()

reset(): void

Defined in: src/ui/handler_manager.ts:53

reset can be called by the manager at any time and must reset everything to it's original state

Returns

void

Inherited from

DragMoveHandler.reset

Properties

renderFrame()?

readonly optional renderFrame: () => void | HandlerResult

Defined in: src/ui/handler_manager.ts:75

renderFrame is the only non-dom event. It is called during render frames and can be used to smooth camera changes (see scroll handler).

Returns

void | HandlerResult

Inherited from

DragMoveHandler.renderFrame