Class: AbstractController

• new AbstractController(options)

• Protected new AbstractController(options?)

AbstractGestureTool.constructor

▸ dispose(): void

Function to clean up the references from this tool.

void

AbstractGestureTool.dispose

▸ getCamera(): Camera

Gets this controler Camera

Camera

▸ getClassName(): string

string

AbstractGestureTool.getClassName

▸ getName(): string

Returns the tool name.

string

The tool's name

AbstractGestureTool.getName

▸ getOptions(): OptionsOut

Get controller options

OptionsOut

options

AbstractGestureTool.getOptions

▸ getPlot(): Plot

Get the plot of this Tool.

Plot

AbstractGestureTool.getPlot

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractGestureTool.hasEventListener

▸ isArmed(): boolean

Return if this tool is 'armed'.
The tool actions are disabled when not armed.
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

AbstractGestureTool.isArmed

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractGestureTool.isDisposed

▸ isSilent(): boolean

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

boolean

AbstractGestureTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractGestureTool.isTouchEvent

▸ notify<E>(type, source, args?): AbstractController

Notify listeners

AbstractController

this

AbstractGestureTool.notify

▸ off<E>(type?, callback?): AbstractController

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.

AbstractController

this

AbstractGestureTool.off

▸ on<E>(type, callback): AbstractController

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

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.

AbstractController

this

AbstractGestureTool.on

▸ onContext(event): void

Called when a 'context' event has occurred

void

AbstractGestureTool.onContext

▸ onCursorMove(event): void

Called when a 'onCursorMove' event has occurred

void

AbstractGestureTool.onCursorMove

▸ onDoubleClick(event): void

Called when a 'doubleclick' event has occurred

void

AbstractGestureTool.onDoubleClick

▸ onDoubleTap(event): void

Called when a 'onDoubleTap' event has occurred

void

AbstractGestureTool.onDoubleTap

▸ onDrag(event): void

Called when a 'onDrag' event has occurred

void

AbstractGestureTool.onDrag

▸ onDragEnd(event): void

Called when a 'onDragEnd' event has occurred

void

AbstractGestureTool.onDragEnd

▸ onDragStart(event): void

Called when a 'onDragStart' event has occurred

void

AbstractGestureTool.onDragStart

▸ onKey(event): void

Called when a 'onKey' event has occurred

void

AbstractGestureTool.onKey

▸ onKeyDown(event): void

Called when a 'keydown' event has occurred

void

AbstractGestureTool.onKeyDown

▸ onKeyEnd(event): void

Called when a 'onKeyEnd' event has occurred

void

AbstractGestureTool.onKeyEnd

▸ onKeyStart(event): void

Called when a 'onKeyStart' event has occurred

void

AbstractGestureTool.onKeyStart

▸ onKeyUp(event): void

Called when a 'keyup' event has occurred

void

AbstractGestureTool.onKeyUp

▸ onMouseDown(event): void

Called when a 'mousedown' event has occurred

void

AbstractGestureTool.onMouseDown

▸ onMouseMove(event): void

Called when a 'mousemove' event has occurred

void

AbstractGestureTool.onMouseMove

▸ onMouseOut(event): void

Called when a 'mouseout' event has occurred

void

AbstractGestureTool.onMouseOut

▸ onMouseUp(event): void

Called when a 'mouseup' event has occurred

void

AbstractGestureTool.onMouseUp

▸ Abstract onMouseWheel(event): void

Called when a 'mousewheel' event has occurred

void

AbstractGestureTool.onMouseWheel

▸ onPinch(event): void

Called when a 'onPinch' event has occurred

void

AbstractGestureTool.onPinch

▸ onPinchEnd(event): void

Called when a 'onPinchEnd' event has occurred

void

AbstractGestureTool.onPinchEnd

▸ onPinchStart(event): void

Called when a 'onPinchStart' event has occurred

void

AbstractGestureTool.onPinchStart

▸ onSlide(event): void

Called when a 'onSlide' event has occurred

void

AbstractGestureTool.onSlide

▸ onSlideEnd(event): void

Called when a 'onSlideEnd' event has occurred

void

AbstractGestureTool.onSlideEnd

▸ onSlideStart(event): void

Called when a 'onSlideStart' event has occurred

void

AbstractGestureTool.onSlideStart

▸ onTap(event): void

Called when a 'onTap' event has occurred

void

AbstractGestureTool.onTap

▸ onTouchEnd(event): void

Called when a 'touchend' event has occurred

void

AbstractGestureTool.onTouchEnd

▸ onTouchMove(event): void

Called when a 'touchmove' event has occurred

void

AbstractGestureTool.onTouchMove

▸ onTouchStart(event): void

Called when a 'touchstart' event has occurred

void

AbstractGestureTool.onTouchStart

▸ onVisibilityChanged(event): void

Called when a 'onVisibilityChanged' event has occurred

void

AbstractGestureTool.onVisibilityChanged

▸ onVisibilityGained(event): void

Called when a 'onVisibilityGained' event has occurred

void

AbstractGestureTool.onVisibilityGained

▸ onVisibilityLost(event): void

Called when a 'onVisibilityLost' event has occurred

void

AbstractGestureTool.onVisibilityLost

▸ setOptions(options?): AbstractController

Set options, the given json will be merged with the object's state so that only the given options will be changed.

AbstractController

this

AbstractGestureTool.setOptions

▸ setSilent(bool): AbstractController

Set silent mode

AbstractController

this

AbstractGestureTool.setSilent

▸ setup(deviceSupport): AbstractController

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

AbstractController

AbstractGestureTool.setup

▸ Static getClassName(): string

string

AbstractGestureTool.getClassName