Class: MeasuringTool

• [new MeasuringTool(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.tool.measuringtool.measuringtool.md#new measuringtool(options))

• new MeasuringTool(options?)

AbstractGestureTool.constructor

▸ dispose(): void

Dispose measuring tool

void

AbstractGestureTool.dispose

▸ getAnchorPosition(): Vector3

Get the Anchor position. Can return null if set/reset to null by the user.

Vector3

▸ getClassName(): string

string

AbstractGestureTool.getClassName

▸ getDefaultPosition(): Vector3

Get the default position for handles, by which the handles position are replaced when calling resetPosition().

Vector3

▸ getDistance(): number

Function to get the current distance of the two points from the tool.

number

distance between the two points, or null if one of the two point is null.

▸ getName(): string

Returns the tool name.

string

The tool's name

AbstractGestureTool.getName

▸ getOptions(): Required<Omit<Options, "resetposition"&gt;&gt;

Get abstract gesture tool options

Required<Omit<Options, "resetposition"&gt;&gt;

options

AbstractGestureTool.getOptions

▸ getPlot(): Plot

Get the plot of this Tool.

Plot

AbstractGestureTool.getPlot

▸ getPointerPosition(): Vector3

Get the Pointer position. Can return null if set/reset to null by the user.

Vector3

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

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&gt;(type, source, args?): MeasuringTool

Notify listeners

MeasuringTool

this

AbstractGestureTool.notify

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

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.

MeasuringTool

this

AbstractGestureTool.off

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

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>

MeasuringTool

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

▸ 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

▸ resetPosition(): MeasuringTool

Reset the handles to the default position.<br> If the default position was set to null, the handles will be hidden and getters for pointer, anchor and distance will return null until updated by the tool operation.

MeasuringTool

▸ setAnchorPosition(position): MeasuringTool

Set the Anchor new position. Can be set to null if desired, which will make the measure line and the Anchor visuals disappears.

MeasuringTool

▸ setChildrenVisibility(visible): MeasuringTool

sets the visibility of this tool visuals (Handles and line, which are children of this object).

MeasuringTool

▸ setDefaultPosition(position, resetPosition?): MeasuringTool

Define the handles default position, and reset the position if desired.<br> If the position is set to null, the handles and line will not be visible until the MeasuringTool is operated to find new positions.

MeasuringTool

▸ setOptions(options): MeasuringTool

Set options

MeasuringTool

AbstractGestureTool.setOptions

▸ setPointerPosition(position): MeasuringTool

Set the Pointer new position. Can be set to null if desired, which will make the measure line and the Pointer visuals disappears.

MeasuringTool

▸ setSilent(bool): MeasuringTool

Set silent mode

MeasuringTool

this

AbstractGestureTool.setSilent

▸ setup(deviceSupport): MeasuringTool

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

MeasuringTool

AbstractGestureTool.setup

▸ Static getClassName(): string

string

AbstractGestureTool.getClassName