Class: SliderMoveTool

• new SliderMoveTool(options)

• new SliderMoveTool(options)

AbstractMoveTool.constructor

▸ addMoveListener(callback): SliderMoveTool

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

SliderMoveTool

this

AbstractMoveTool.addMoveListener

▸ dispose(): void

Function to clean up the references from this tool.

void

AbstractMoveTool.dispose

▸ getClassName(): string

string

AbstractMoveTool.getClassName

▸ getName(): string

Returns the tool name.

string

The tool's name

AbstractMoveTool.getName

▸ getOptions(): Required<Options>

Get abstract gesture tool options

Required<Options>

options

AbstractMoveTool.getOptions

▸ getPlot(): Plot

Get the plot of this Tool.

Plot

AbstractMoveTool.getPlot

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractMoveTool.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

AbstractMoveTool.isArmed

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractMoveTool.isDisposed

▸ isSilent(): boolean

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

boolean

AbstractMoveTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractMoveTool.isTouchEvent

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

Notify listeners

SliderMoveTool

this

AbstractMoveTool.notify

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

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.

SliderMoveTool

this

AbstractMoveTool.off

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

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.

SliderMoveTool

this

AbstractMoveTool.on

▸ onContext(event): void

Called when a 'context' event has occurred

void

AbstractMoveTool.onContext

▸ onCursorMove(event): void

Called when a 'onCursorMove' event has occurred

void

AbstractMoveTool.onCursorMove

▸ onDoubleClick(event): void

Called when a 'doubleclick' event has occurred

void

AbstractMoveTool.onDoubleClick

▸ onDoubleTap(event): void

Called when a 'onDoubleTap' event has occurred

void

AbstractMoveTool.onDoubleTap

▸ onDrag(event): void

Called when a 'onDrag' event has occurred

void

AbstractMoveTool.onDrag

▸ onDragEnd(event): void

Called when a 'onDragEnd' event has occurred

void

AbstractMoveTool.onDragEnd

▸ onDragStart(event): void

Called when a 'onDragStart' event has occurred

void

AbstractMoveTool.onDragStart

▸ onKey(event): void

Called when a 'onKey' event has occurred

void

AbstractMoveTool.onKey

▸ onKeyDown(event): void

Called when a 'keydown' event has occurred

void

AbstractMoveTool.onKeyDown

▸ onKeyEnd(event): void

Called when a 'onKeyEnd' event has occurred

void

AbstractMoveTool.onKeyEnd

▸ onKeyStart(event): void

Called when a 'onKeyStart' event has occurred

void

AbstractMoveTool.onKeyStart

▸ onKeyUp(event): void

Called when a 'keyup' event has occurred

void

AbstractMoveTool.onKeyUp

▸ onMouseDown(event): void

Called when a 'mousedown' event has occurred

void

AbstractMoveTool.onMouseDown

▸ onMouseMove(event): void

Called when a 'mousemove' event has occurred

void

AbstractMoveTool.onMouseMove

▸ onMouseOut(event): void

Called when a 'mouseout' event has occurred

void

AbstractMoveTool.onMouseOut

▸ onMouseUp(event): void

Called when a 'mouseup' event has occurred

void

AbstractMoveTool.onMouseUp

▸ onMouseWheel(event): void

Called when a 'mousewheel' event has occurred

void

AbstractMoveTool.onMouseWheel

▸ onPick(event): void

Called when a 'onPick' event has occurred

void

AbstractMoveTool.onPick

▸ onPinch(event): void

Called when a 'onPinch' event has occurred

void

AbstractMoveTool.onPinch

▸ onPinchEnd(event): void

Called when a 'onPinchEnd' event has occurred

void

AbstractMoveTool.onPinchEnd

▸ onPinchStart(event): void

Called when a 'onPinchStart' event has occurred

void

AbstractMoveTool.onPinchStart

▸ onSlide(event): void

Called when a 'onSlide' event has occurred

void

AbstractMoveTool.onSlide

▸ onSlideEnd(event): void

Called when a 'onSlideEnd' event has occurred

void

AbstractMoveTool.onSlideEnd

▸ onSlideStart(event): void

Called when a 'onSlideStart' event has occurred

void

AbstractMoveTool.onSlideStart

▸ onTap(event): void

Called when a 'onTap' event has occurred

void

AbstractMoveTool.onTap

▸ onTouchEnd(event): void

Called when a 'touchend' event has occurred

void

AbstractMoveTool.onTouchEnd

▸ onTouchMove(event): void

Called when a 'touchmove' event has occurred

void

AbstractMoveTool.onTouchMove

▸ onTouchStart(event): void

Called when a 'touchstart' event has occurred

void

AbstractMoveTool.onTouchStart

▸ onVisibilityChanged(event): void

Called when a 'onVisibilityChanged' event has occurred

void

AbstractMoveTool.onVisibilityChanged

▸ onVisibilityGained(event): void

Called when a 'onVisibilityGained' event has occurred

void

AbstractMoveTool.onVisibilityGained

▸ onVisibilityLost(event): void

Called when a 'onVisibilityLost' event has occurred

void

AbstractMoveTool.onVisibilityLost

▸ removeSelectionListener(callback): SliderMoveTool

Removes a listener

SliderMoveTool

this

AbstractMoveTool.removeSelectionListener

▸ setMoveFunction(func): SliderMoveTool

Sets the function that should apply the computed 'move operation' to the targeted object.

Function parameters are:
{THREE.Object3D} object The object being moved
{THREE.Vector2} move The displacement in screen space to apply
{THREE.Vector2} initialPoint The initial point
Function should return 'true' to reset the reference point used for distance calculation

SliderMoveTool

this

▸ setOptions(options): SliderMoveTool

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

SliderMoveTool

this

AbstractMoveTool.setOptions

▸ setSilent(bool): SliderMoveTool

Set silent mode

SliderMoveTool

this

AbstractMoveTool.setSilent

▸ setup(deviceSupport): SliderMoveTool

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

SliderMoveTool

AbstractMoveTool.setup

▸ Static getClassName(): string

string

AbstractMoveTool.getClassName