Skip to content

API / geotoolkit3d / tool / AbstractMoveTool / AbstractMoveTool

Class: AbstractMoveTool

tool.AbstractMoveTool.AbstractMoveTool

A base class to implement custom tools that move objects into the scene.<br>

Hierarchy

Table of contents

Constructors
  • [new AbstractMoveTool(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.tool.abstractmovetool.abstractmovetool.md#new abstractmovetool(options))
Methods

Contents

Constructors

new AbstractMoveTool(options)

• Protected new AbstractMoveTool(options)

Parameters

Name Type
optionsOptions

Overrides

AbstractGestureTool.constructor

Methods

addMoveListener

▸ addMoveListener(callback): AbstractMoveTool

Adds a listener that will be triggered each time this tool 'move' occurs.

Parameters

Name Type Description
callbackListenerCallbackThe function that will be called

Returns

AbstractMoveTool

this


dispose

▸ dispose(): void

Function to clean up the references from this tool.

Returns

void

Inherited from

AbstractGestureTool.dispose


getClassName

▸ getClassName(): string

Returns

string

Inherited from

AbstractGestureTool.getClassName


getName

▸ getName(): string

Returns the tool name.

Returns

string

The tool's name

Inherited from

AbstractGestureTool.getName


getOptions

▸ getOptions(): Required<Options&gt;

Get abstract gesture tool options

Returns

Required<Options&gt;

options

Overrides

AbstractGestureTool.getOptions


getPlot

▸ getPlot(): Plot

Get the plot of this Tool.

Returns

Plot

Inherited from

AbstractGestureTool.getPlot


hasEventListener

▸ hasEventListener(type, callback?): boolean

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

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

AbstractGestureTool.hasEventListener


isArmed

▸ 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().

Returns

boolean

Inherited from

AbstractGestureTool.isArmed


isDisposed

▸ isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

AbstractGestureTool.isDisposed


isSilent

▸ isSilent(): boolean

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

Returns

boolean

Inherited from

AbstractGestureTool.isSilent


isTouchEvent

▸ isTouchEvent(eventArgs): boolean

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

Parameters

Name Type Description
eventArgsEvent | EventArgscontains info of the event

Returns

boolean

Inherited from

AbstractGestureTool.isTouchEvent


notify

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

Notify listeners

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEevent types
sourceAbstractToolof the event
Optional argsEventMap[E]arguments of the event

Returns

AbstractMoveTool

this

Inherited from

AbstractGestureTool.notify


off

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

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: AbstractMoveTool, args: EventMap[E]) => voidfunction to be called

Returns

AbstractMoveTool

this

Inherited from

AbstractGestureTool.off


on

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

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>

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: AbstractMoveTool, args: EventMap[E]) => voidto be called

Returns

AbstractMoveTool

this

Inherited from

AbstractGestureTool.on


onContext

▸ onContext(event): void

Called when a 'context' event has occurred

Parameters

Name Type Description
eventPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onContext


onCursorMove

▸ onCursorMove(event): void

Called when a 'onCursorMove' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onCursorMove


onDoubleClick

▸ onDoubleClick(event): void

Called when a 'doubleclick' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onDoubleClick


onDoubleTap

▸ onDoubleTap(event): void

Called when a 'onDoubleTap' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onDoubleTap


onDrag

▸ onDrag(event): void

Called when a 'onDrag' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onDrag


onDragEnd

▸ onDragEnd(event): void

Called when a 'onDragEnd' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onDragEnd


onDragStart

▸ onDragStart(event): void

Called when a 'onDragStart' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onDragStart


onKey

▸ onKey(event): void

Called when a 'onKey' event has occurred

Parameters

Name Type Description
eventKeyboardEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onKey


onKeyDown

▸ onKeyDown(event): void

Called when a 'keydown' event has occurred

Parameters

Name Type Description
eventKeyboardEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onKeyDown


onKeyEnd

▸ onKeyEnd(event): void

Called when a 'onKeyEnd' event has occurred

Parameters

Name Type Description
eventKeyboardEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onKeyEnd


onKeyStart

▸ onKeyStart(event): void

Called when a 'onKeyStart' event has occurred

Parameters

Name Type Description
eventKeyboardEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onKeyStart


onKeyUp

▸ onKeyUp(event): void

Called when a 'keyup' event has occurred

Parameters

Name Type Description
eventKeyboardEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onKeyUp


onMouseDown

▸ onMouseDown(event): void

Called when a 'mousedown' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onMouseDown


onMouseMove

▸ onMouseMove(event): void

Called when a 'mousemove' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onMouseMove


onMouseOut

▸ onMouseOut(event): void

Called when a 'mouseout' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onMouseOut


onMouseUp

▸ onMouseUp(event): void

Called when a 'mouseup' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onMouseUp


onMouseWheel

▸ onMouseWheel(event): void

Called when a 'mousewheel' event has occurred

Parameters

Name Type Description
eventWheelEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onMouseWheel


onPick

▸ onPick(event): void

Called when a 'onPick' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void


onPinch

▸ onPinch(event): void

Called when a 'onPinch' event has occurred

Parameters

Name Type Description
eventMovePointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onPinch


onPinchEnd

▸ onPinchEnd(event): void

Called when a 'onPinchEnd' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onPinchEnd


onPinchStart

▸ onPinchStart(event): void

Called when a 'onPinchStart' event has occurred

Parameters

Name Type Description
eventMovePointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onPinchStart


onSlide

▸ onSlide(event): void

Called when a 'onSlide' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onSlide


onSlideEnd

▸ onSlideEnd(event): void

Called when a 'onSlideEnd' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onSlideEnd


onSlideStart

▸ onSlideStart(event): void

Called when a 'onSlideStart' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onSlideStart


onTap

▸ onTap(event): void

Called when a 'onTap' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onTap


onTouchEnd

▸ onTouchEnd(event): void

Called when a 'touchend' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onTouchEnd


onTouchMove

▸ onTouchMove(event): void

Called when a 'touchmove' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onTouchMove


onTouchStart

▸ onTouchStart(event): void

Called when a 'touchstart' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onTouchStart


onVisibilityChanged

▸ onVisibilityChanged(event): void

Called when a 'onVisibilityChanged' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Inherited from

AbstractGestureTool.onVisibilityChanged


onVisibilityGained

▸ onVisibilityGained(event): void

Called when a 'onVisibilityGained' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onVisibilityGained


onVisibilityLost

▸ onVisibilityLost(event): void

Called when a 'onVisibilityLost' event has occurred

Parameters

Name Type Description
eventCustomPointerEventthe native event with plot coordinates added

Returns

void

Overrides

AbstractGestureTool.onVisibilityLost


removeSelectionListener

▸ removeSelectionListener(callback): AbstractMoveTool

Removes a listener

Parameters

Name Type Description
callbackListenerCallbackThe callback to remove

Returns

AbstractMoveTool

this


setOptions

▸ setOptions(options): AbstractMoveTool

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

Parameters

Name Type Description
optionsOptionsThe options

Returns

AbstractMoveTool

this

Overrides

AbstractGestureTool.setOptions


setSilent

▸ setSilent(bool): AbstractMoveTool

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

AbstractMoveTool

this

Inherited from

AbstractGestureTool.setSilent


setup

▸ setup(deviceSupport): AbstractMoveTool

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

Parameters

Name Type Description
deviceSupportAbstractDeviceSupportthe type of device we are attaching to

Returns

AbstractMoveTool

Inherited from

AbstractGestureTool.setup


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

AbstractGestureTool.getClassName