Class: SeismicSliderTool

• new SeismicSliderTool(options)

• new SeismicSliderTool(options)

SliderMoveTool.constructor

▸ addMoveListener(callback): SeismicSliderTool

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

SeismicSliderTool

this

SliderMoveTool.addMoveListener

▸ dispose(): void

Function to clean up the references from this tool.

void

SliderMoveTool.dispose

▸ getClassName(): string

string

SliderMoveTool.getClassName

▸ getName(): string

Returns the tool name.

string

The tool's name

SliderMoveTool.getName

▸ getOptions(): Required<Options>

Get abstract gesture tool options

Required<Options>

options

SliderMoveTool.getOptions

▸ getPlot(): Plot

Get the plot of this Tool.

Plot

SliderMoveTool.getPlot

▸ hasEventListener(type, callback?): boolean

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

boolean

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

SliderMoveTool.isArmed

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

SliderMoveTool.isDisposed

▸ isSilent(): boolean

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

boolean

SliderMoveTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

SliderMoveTool.isTouchEvent

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

Notify listeners

SeismicSliderTool

this

SliderMoveTool.notify

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

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.

SeismicSliderTool

this

SliderMoveTool.off

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

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.

SeismicSliderTool

this

SliderMoveTool.on

▸ onContext(event): void

Called when a 'context' event has occurred

void

SliderMoveTool.onContext

▸ onCursorMove(event): void

Called when a 'onCursorMove' event has occurred

void

SliderMoveTool.onCursorMove

▸ onDoubleClick(event): void

Called when a 'doubleclick' event has occurred

void

SliderMoveTool.onDoubleClick

▸ onDoubleTap(event): void

Called when a 'onDoubleTap' event has occurred

void

SliderMoveTool.onDoubleTap

▸ onDrag(event): void

Called when a 'onDrag' event has occurred

void

SliderMoveTool.onDrag

▸ onDragEnd(event): void

Called when a 'onDragEnd' event has occurred

void

SliderMoveTool.onDragEnd

▸ onDragStart(event): void

Called when a 'onDragStart' event has occurred

void

SliderMoveTool.onDragStart

▸ onKey(event): void

Called when a 'onKey' event has occurred

void

SliderMoveTool.onKey

▸ onKeyDown(event): void

Called when a 'keydown' event has occurred

void

SliderMoveTool.onKeyDown

▸ onKeyEnd(event): void

Called when a 'onKeyEnd' event has occurred

void

SliderMoveTool.onKeyEnd

▸ onKeyStart(event): void

Called when a 'onKeyStart' event has occurred

void

SliderMoveTool.onKeyStart

▸ onKeyUp(event): void

Called when a 'keyup' event has occurred

void

SliderMoveTool.onKeyUp

▸ onMouseDown(event): void

Called when a 'mousedown' event has occurred

void

SliderMoveTool.onMouseDown

▸ onMouseMove(event): void

Called when a 'mousemove' event has occurred

void

SliderMoveTool.onMouseMove

▸ onMouseOut(event): void

Called when a 'mouseout' event has occurred

void

SliderMoveTool.onMouseOut

▸ onMouseUp(event): void

Called when a 'mouseup' event has occurred

void

SliderMoveTool.onMouseUp

▸ onMouseWheel(event): void

Called when a 'mousewheel' event has occurred

void

SliderMoveTool.onMouseWheel

▸ onPick(event): void

Called when a 'onPick' event has occurred

void

SliderMoveTool.onPick

▸ onPinch(event): void

Called when a 'onPinch' event has occurred

void

SliderMoveTool.onPinch

▸ onPinchEnd(event): void

Called when a 'onPinchEnd' event has occurred

void

SliderMoveTool.onPinchEnd

▸ onPinchStart(event): void

Called when a 'onPinchStart' event has occurred

void

SliderMoveTool.onPinchStart

▸ onSlide(event): void

Called when a 'onSlide' event has occurred

void

SliderMoveTool.onSlide

▸ onSlideEnd(event): void

Called when a 'onSlideEnd' event has occurred

void

SliderMoveTool.onSlideEnd

▸ onSlideStart(event): void

Called when a 'onSlideStart' event has occurred

void

SliderMoveTool.onSlideStart

▸ onTap(event): void

Called when a 'onTap' event has occurred

void

SliderMoveTool.onTap

▸ onTouchEnd(event): void

Called when a 'touchend' event has occurred

void

SliderMoveTool.onTouchEnd

▸ onTouchMove(event): void

Called when a 'touchmove' event has occurred

void

SliderMoveTool.onTouchMove

▸ onTouchStart(event): void

Called when a 'touchstart' event has occurred

void

SliderMoveTool.onTouchStart

▸ onVisibilityChanged(event): void

Called when a 'onVisibilityChanged' event has occurred

void

SliderMoveTool.onVisibilityChanged

▸ onVisibilityGained(event): void

Called when a 'onVisibilityGained' event has occurred

void

SliderMoveTool.onVisibilityGained

▸ onVisibilityLost(event): void

Called when a 'onVisibilityLost' event has occurred

void

SliderMoveTool.onVisibilityLost

▸ removeSelectionListener(callback): SeismicSliderTool

Removes a listener

SeismicSliderTool

this

SliderMoveTool.removeSelectionListener

▸ setMoveFunction(func): SeismicSliderTool

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

SeismicSliderTool

this

SliderMoveTool.setMoveFunction

▸ setOptions(options): SeismicSliderTool

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

SeismicSliderTool

this

SliderMoveTool.setOptions

▸ setSilent(bool): SeismicSliderTool

Set silent mode

SeismicSliderTool

this

SliderMoveTool.setSilent

▸ setVolume(volume): void

Sets volume

void

▸ setup(deviceSupport): SeismicSliderTool

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

SeismicSliderTool

SliderMoveTool.setup

▸ Static getClassName(): string

string

SliderMoveTool.getClassName