Class: RollController

• [new RollController(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.controller.rollcontroller.rollcontroller.md#new rollcontroller(options))

• new RollController(options?)

AbstractController.constructor

▸ dispose(): void

Function to clean up the references from this tool.

void

AbstractController.dispose

▸ getCamera(): Camera

Gets this controler Camera

Camera

AbstractController.getCamera

▸ getClassName(): string

string

AbstractController.getClassName

▸ getName(): string

Returns the tool name.

string

The tool's name

AbstractController.getName

▸ getOptions(): OptionsOut

Get roll controller options

OptionsOut

options

AbstractController.getOptions

▸ getPlot(): Plot

Get the plot of this Tool.

Plot

AbstractController.getPlot

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

AbstractController.hasEventListener

▸ isArmed(): boolean

Return if this tool is 'armed'.<br> The tool actions are disabled when not armed.<br> A tool can either be armed at all time, or only when a specific key is pressed. To set/unset the arming key, please see this tool option 'armingkey', via .setOptions().

boolean

AbstractController.isArmed

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractController.isDisposed

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

AbstractController.isSilent

▸ isTouchEvent(eventArgs): boolean

return true if the event is a touch event and false otherwise.

boolean

AbstractController.isTouchEvent

▸ notify<E&gt;(type, source, args?): RollController

Notify listeners

RollController

this

AbstractController.notify

▸ off<E&gt;(type?, callback?): RollController

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

RollController

this

AbstractController.off

▸ on<E&gt;(type, callback): RollController

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p>

RollController

this

AbstractController.on

▸ onContext(event): void

Called when a 'context' event has occurred

void

AbstractController.onContext

▸ onCursorMove(event): void

Called when a 'onCursorMove' event has occurred

void

AbstractController.onCursorMove

▸ onDoubleClick(event): void

Called when a 'doubleclick' event has occurred

void

AbstractController.onDoubleClick

▸ onDoubleTap(event): void

Called when a 'onDoubleTap' event has occurred

void

AbstractController.onDoubleTap

▸ onDrag(event): void

Called when a 'onDrag' event has occurred

void

AbstractController.onDrag

▸ onDragEnd(event): void

Called when a 'onDragEnd' event has occurred

void

AbstractController.onDragEnd

▸ onDragStart(event): void

Called when a 'onDragStart' event has occurred

void

AbstractController.onDragStart

▸ onKey(event): void

Called when a 'onKey' event has occurred

void

AbstractController.onKey

▸ onKeyDown(event): void

Called when a 'keydown' event has occurred

void

AbstractController.onKeyDown

▸ onKeyEnd(event): void

Called when a 'onKeyEnd' event has occurred

void

AbstractController.onKeyEnd

▸ onKeyStart(event): void

Called when a 'onKeyStart' event has occurred

void

AbstractController.onKeyStart

▸ onKeyUp(event): void

Called when a 'keyup' event has occurred

void

AbstractController.onKeyUp

▸ onMouseDown(event): void

Called when a 'mousedown' event has occurred

void

AbstractController.onMouseDown

▸ onMouseMove(event): void

Called when a 'mousemove' event has occurred

void

AbstractController.onMouseMove

▸ onMouseOut(event): void

Called when a 'mouseout' event has occurred

void

AbstractController.onMouseOut

▸ onMouseUp(event): void

Called when a 'mouseup' event has occurred

void

AbstractController.onMouseUp

▸ onMouseWheel(event): void

Called when a 'mousewheel' event has occurred

void

AbstractController.onMouseWheel

▸ onPinch(event): void

Called when a 'onPinch' event has occurred

void

AbstractController.onPinch

▸ onPinchEnd(event): void

Called when a 'onPinchEnd' event has occurred

void

AbstractController.onPinchEnd

▸ onPinchStart(event): void

Called when a 'onPinchStart' event has occurred

void

AbstractController.onPinchStart

▸ onSlide(event): void

Called when a 'onSlide' event has occurred

void

AbstractController.onSlide

▸ onSlideEnd(event): void

Called when a 'onSlideEnd' event has occurred

void

AbstractController.onSlideEnd

▸ onSlideStart(event): void

Called when a 'onSlideStart' event has occurred

void

AbstractController.onSlideStart

▸ onTap(event): void

Called when a 'onTap' event has occurred

void

AbstractController.onTap

▸ onTouchEnd(event): void

Called when a 'touchend' event has occurred

void

AbstractController.onTouchEnd

▸ onTouchMove(event): void

Called when a 'touchmove' event has occurred

void

AbstractController.onTouchMove

▸ onTouchStart(event): void

Called when a 'touchstart' event has occurred

void

AbstractController.onTouchStart

▸ onVisibilityChanged(event): void

Called when a 'onVisibilityChanged' event has occurred

void

AbstractController.onVisibilityChanged

▸ onVisibilityGained(event): void

Called when a 'onVisibilityGained' event has occurred

void

AbstractController.onVisibilityGained

▸ onVisibilityLost(event): void

Called when a 'onVisibilityLost' event has occurred

void

AbstractController.onVisibilityLost

▸ setOptions(options?): RollController

Set roll controller options

RollController

this

AbstractController.setOptions

▸ setSilent(bool): RollController

Set silent mode

RollController

this

AbstractController.setSilent

▸ setup(deviceSupport): RollController

This function allows tools to bind their events to the device support

RollController

AbstractController.setup

▸ Static getClassName(): string

string

AbstractController.getClassName