Skip to content

API / geotoolkit3d / tool / seismic / SeismicSliderTool / SeismicSliderTool

Class: SeismicSliderTool

seismic.SeismicSliderTool.SeismicSliderTool

A tool specialized in moving a seismicslice.<br> <br> This tool uses the given Volume object to limit the slice displacement.<br> Note that this tool simply moves the slice, calling code is responsible of updating the seismic data displayed.<br>

Hierarchy

Table of contents

Constructors
  • [new SeismicSliderTool(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.tool.seismic-2.seismicslidertool.seismicslidertool.md#new seismicslidertool(options))
Methods

Contents

Constructors

new SeismicSliderTool(options)

• new SeismicSliderTool(options)

Parameters

Name Type
optionsOptions

Overrides

SliderMoveTool.constructor

Methods

addMoveListener

▸ addMoveListener(callback): SeismicSliderTool

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

Parameters

Name Type Description
callbackListenerCallbackThe function that will be called

Returns

SeismicSliderTool

this

Inherited from

SliderMoveTool.addMoveListener


dispose

▸ dispose(): void

Function to clean up the references from this tool.

Returns

void

Inherited from

SliderMoveTool.dispose


getClassName

▸ getClassName(): string

Returns

string

Inherited from

SliderMoveTool.getClassName


getName

▸ getName(): string

Returns the tool name.

Returns

string

The tool's name

Inherited from

SliderMoveTool.getName


getOptions

▸ getOptions(): Required<Options&gt;

Get abstract gesture tool options

Returns

Required<Options&gt;

options

Inherited from

SliderMoveTool.getOptions


getPlot

▸ getPlot(): Plot

Get the plot of this Tool.

Returns

Plot

Inherited from

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

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

SliderMoveTool.isArmed


isDisposed

▸ isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

SliderMoveTool.isDisposed


isSilent

▸ isSilent(): boolean

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

Returns

boolean

Inherited from

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

SliderMoveTool.isTouchEvent


notify

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

Notify listeners

Type parameters

NameType
Eextends string

Parameters

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

Returns

SeismicSliderTool

this

Inherited from

SliderMoveTool.notify


off

▸ off<E&gt;(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.

Type parameters

NameType
Eextends string

Parameters

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

Returns

SeismicSliderTool

this

Inherited from

SliderMoveTool.off


on

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

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: SeismicSliderTool, args: EventMap[E]) => voidto be called

Returns

SeismicSliderTool

this

Inherited from

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

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

Inherited from

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

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

Inherited from

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

Inherited from

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

Inherited from

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

Inherited from

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

Inherited from

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

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

Inherited from

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

Inherited from

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

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

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

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

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

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

Inherited from

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

Inherited from

SliderMoveTool.onPick


onPinch

▸ onPinch(event): void

Called when a 'onPinch' event has occurred

Parameters

Name Type Description
eventMovePointerEventthe native event with plot coordinates added

Returns

void

Inherited from

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

Inherited from

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

Inherited from

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

Inherited from

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

Inherited from

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

Inherited from

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

Inherited from

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

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

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

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

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

Inherited from

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

Inherited from

SliderMoveTool.onVisibilityLost


removeSelectionListener

▸ removeSelectionListener(callback): SeismicSliderTool

Removes a listener

Parameters

Name Type Description
callbackListenerCallbackThe callback to remove

Returns

SeismicSliderTool

this

Inherited from

SliderMoveTool.removeSelectionListener


setMoveFunction

▸ setMoveFunction(func): SeismicSliderTool

Sets the function that should apply the computed 'move operation' to the targeted object.<br> <br> Function parameters are:<br> {THREE.Object3D} object The object being moved<br> {THREE.Vector2} move The displacement in screen space to apply<br> {THREE.Vector2} initialPoint The initial point<br> Function should return 'true' to reset the reference point used for distance calculation<br>

Parameters

Name Type Description
funcApplyMoveFunctionThe function

Returns

SeismicSliderTool

this

Inherited from

SliderMoveTool.setMoveFunction


setOptions

▸ 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.<br>

Parameters

Name Type Description
optionsOptionsSee AbstractMoveTool.setOptions for inherited options

Returns

SeismicSliderTool

this

Inherited from

SliderMoveTool.setOptions


setSilent

▸ setSilent(bool): SeismicSliderTool

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

SeismicSliderTool

this

Inherited from

SliderMoveTool.setSilent


setVolume

▸ setVolume(volume): void

Sets volume

Parameters

Name Type Description
volumeVolumevolume

Returns

void


setup

▸ setup(deviceSupport): SeismicSliderTool

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

SeismicSliderTool

Inherited from

SliderMoveTool.setup


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

SliderMoveTool.getClassName