Class: DepthShiftingTool

• new DepthShiftingTool(options)

• new DepthShiftingTool(options?)

AbstractLogVisualEditingTool.constructor

▸ addDepthMapping(mapping): DepthShiftingTool

Sets depth mapping array

DepthShiftingTool

this

▸ Protected addHandle(handle): DepthShiftingTool

Add editor handle

DepthShiftingTool

this

AbstractLogVisualEditingTool.addHandle

▸ addListener(eventName, listener): DepthShiftingTool

add event listener. The listener receives the message when the system event happens.

Deprecated

since 4.0 use .on() instead. Note that 3 args callback should be used in subscription via .on(): (eventType, source, args)

DepthShiftingTool

AbstractLogVisualEditingTool.addListener

▸ captureMouseUp(): void

listen to window mouse events in order to catch a mouse up action outside of the tool container DOM element. useful for example when you pan and release click outside of DOM element.

void

AbstractLogVisualEditingTool.captureMouseUp

▸ clearDepthMapping(): DepthShiftingTool

Remove all depth mappings from this tool

DepthShiftingTool

this

▸ Protected clearHandles(): DepthShiftingTool

Clears all the handles from the adapter and manipulator layer

DepthShiftingTool

▸ dispose(): void

Dispose tool.

void

AbstractLogVisualEditingTool.dispose

▸ fireEvent(eventName, eventArgs?): void

This method is Protected. Fire an Event.

Deprecated

since 4.0 use .notify() instead. Note that 3 args callback should be used in subscription via .on()

void

AbstractLogVisualEditingTool.fireEvent

▸ getActiveHandle(): GhostBearingHandle

Returns currently active handle,if exists, otherwise null

GhostBearingHandle

AbstractLogVisualEditingTool.getActiveHandle

▸ getCachedManipulatorLayer(): CompositeNode<Node>

Gets the manipulator layer with contains handles

Deprecated

since 4.0. Use AbstractLogVisualEditingTool#getManipulatorLayer instead

CompositeNode<Node>

AbstractLogVisualEditingTool.getCachedManipulatorLayer

▸ getClassName(): string

string

AbstractLogVisualEditingTool.getClassName

▸ Protected getDepthLabel(mapping): string

Returns depth label text

string

depth label

▸ getDepthMapping(index): Object

Return depth mapping by specified index

Object

depth mapping

▸ getDepthMappings(): { from: number ; to: number }[]

{ from: number ; to: number }[]

depth mappings

▸ getDepthMappingsCount(): number

Returns depth mappings count

number

depth mappings count

▸ Protected getDeviceXY(args): Point

Returns a point in model coordinates, edits one of the util points

Point

AbstractLogVisualEditingTool.getDeviceXY

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractLogVisualEditingTool.getEventRadius

▸ Protected getHandle(index): GhostBearingHandle

GhostBearingHandle

AbstractLogVisualEditingTool.getHandle

▸ getHandlePainter(): Painter

Gets the shape painter with which is used to render handles. Format is the same as in SymbolShape Redraws all handles

Painter

painter

AbstractLogVisualEditingTool.getHandlePainter

▸ getHandleSize(): number

Get the size of the handles

number

AbstractLogVisualEditingTool.getHandleSize

▸ getHandleStyles(): HandleStylesOut

Returns registered styles for active, inactive, and ghost states of all handles

HandleStylesOut

object containing stylings for different types of handle states

AbstractLogVisualEditingTool.getHandleStyles

▸ Protected getHandlesCount(): number

Return number of handles

number

number of handles

AbstractLogVisualEditingTool.getHandlesCount

▸ getHideGhostOnDrop(): boolean

Gets a flag defining if the ghost should be reset after it has been dropped

boolean

AbstractLogVisualEditingTool.getHideGhostOnDrop

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractLogVisualEditingTool.getManipulatorLayer

▸ getMode(): Mode

Retrieves the type of editing that this adapter is doing

Mode

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractLogVisualEditingTool.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractLogVisualEditingTool.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractLogVisualEditingTool.getParentTool

▸ getPosition(): Point

Returns the last registered position of the mouse in device space

Point

AbstractLogVisualEditingTool.getPosition

▸ getProperties(): OptionsOut

Returns all the properties pertaining to this object

OptionsOut

An object containing the properties

AbstractLogVisualEditingTool.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

AbstractLogVisualEditingTool.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractLogVisualEditingTool.getPropertyKeys

▸ getRange(): Range

Return depth range model limits

Range

depth range model limits

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractLogVisualEditingTool.getRoot

▸ getShape(): Node

Returns the shape which this tool is manipulating

Node

AbstractLogVisualEditingTool.getShape

▸ getShowGhost(): boolean

Returns the flag defining if a ghost should be moved instead of the actual object

boolean

showGhost Show ghost flag

AbstractLogVisualEditingTool.getShowGhost

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractLogVisualEditingTool.getTouchRadius

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractLogVisualEditingTool.hasEventListener

▸ isActive(): boolean

return active state

boolean

AbstractLogVisualEditingTool.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractLogVisualEditingTool.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractLogVisualEditingTool.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractLogVisualEditingTool.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractLogVisualEditingTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractLogVisualEditingTool.isTouchEvent

▸ Protected makeSelection(x, y): Node[]

Makes a selection according to current position of the pointer

Node[]

AbstractLogVisualEditingTool.makeSelection

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

Notify listeners

DepthShiftingTool

this

AbstractLogVisualEditingTool.notify

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

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.

DepthShiftingTool

this

AbstractLogVisualEditingTool.off

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

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.

Example

// Using in derived tool
import type {EventMap as EventMapBase} from '@int/geotoolkit/controls/tools/AbstractTool';
export type EventMap = EventMapBase & {
[MyToolEvents.onValueChanged]: MyToolEventArgs
}
export enum MyToolEvents {
onValueChanged = 'onValueChanged'
}
export class MyTool extends AbstractTool {
public declare on: <E extends keyof EventMap>(type: E, callback: (eventType: E, sender: this, args: EventMap[E]) => void) => this;
protected declare notify: <E extends keyof EventMap>(type: E, source: AbstractTool, args?: EventMap[E]) => this;
public declare off: <E extends keyof EventMap>(type: E, callback?: (eventType: E, sender: this, args: EventMap[E]) => void) => this;
// ...
}

DepthShiftingTool

AbstractLogVisualEditingTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractLogVisualEditingTool.onActiveStateChanged

▸ Protected onEnabledStateChanged(): void

Called when the tool is enabled or disabled

void

AbstractLogVisualEditingTool.onEnabledStateChanged

▸ onMouseDown(eventArgs): void

Handles the event caused by user pressing the mouse button

void

AbstractLogVisualEditingTool.onMouseDown

▸ onMouseMove(eventArgs): void

Handles the event caused by user moving the mouse

void

AbstractLogVisualEditingTool.onMouseMove

▸ onMouseUp(eventArgs): void

Handles the event caused by user releasing the mouse button

void

AbstractLogVisualEditingTool.onMouseUp

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractLogVisualEditingTool.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractLogVisualEditingTool.pointToModel

▸ removeDepthMapping(index): DepthShiftingTool

Remove depth maooing at specified index

DepthShiftingTool

this

▸ Protected removeHandle(handle, disposeHandles?): DepthShiftingTool

Remove handles

DepthShiftingTool

this

AbstractLogVisualEditingTool.removeHandle

▸ removeListener(eventName, listener?): DepthShiftingTool

remove event listener. The listener reveives the message when the system event happens.

Deprecated

since 4.0 use .off() instead.

DepthShiftingTool

AbstractLogVisualEditingTool.removeListener

▸ setActive(active): DepthShiftingTool

set active state

Fires

Events.onStateChanged

DepthShiftingTool

AbstractLogVisualEditingTool.setActive

▸ setActiveHandle(handle): DepthShiftingTool

Sets the handle currently active

DepthShiftingTool

AbstractLogVisualEditingTool.setActiveHandle

▸ setDepthLabelCallback(callback): DepthShiftingTool

Set visuals filter callback

DepthShiftingTool

this

▸ setEnabled(enabled): DepthShiftingTool

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

DepthShiftingTool

this

AbstractLogVisualEditingTool.setEnabled

▸ setHandlePainter(painter): DepthShiftingTool

Sets the shape painter with which the handles will be drawn. Format is the same as in geotoolkit.scene.shapes.SymbolShape Redraws all handles

DepthShiftingTool

AbstractLogVisualEditingTool.setHandlePainter

▸ setHandleSize(size): DepthShiftingTool

Sets the pixel side of the handles to which a size is applicable (anchored handles)

DepthShiftingTool

AbstractLogVisualEditingTool.setHandleSize

▸ setHandleStyles(styles): DepthShiftingTool

Sets styles for active, inactive, and ghost states of all handles, and redraws each handle (this will lose edited handles position)

DepthShiftingTool

AbstractLogVisualEditingTool.setHandleStyles

▸ Protected setHandlesVisible(visible): DepthShiftingTool

Iterates through handles and sets the provided visibility. If the visibility is to hide, hides the ghosts as well

DepthShiftingTool

AbstractLogVisualEditingTool.setHandlesVisible

▸ setHideGhostOnDrop(hide): DepthShiftingTool

Gets a flag defining if the ghost should be reset after it has been dropped

DepthShiftingTool

AbstractLogVisualEditingTool.setHideGhostOnDrop

▸ setMode(mode): DepthShiftingTool

Sets what kind of edition this adapter has to do for the curve

DepthShiftingTool

▸ setMouseRadius(radius): DepthShiftingTool

Sets device radius for mouse events

DepthShiftingTool

this

AbstractLogVisualEditingTool.setMouseRadius

▸ setName(name): DepthShiftingTool

set tool name

DepthShiftingTool

AbstractLogVisualEditingTool.setName

▸ setPosition(x, y): DepthShiftingTool

Sets the last registered position of the mouse in device space

DepthShiftingTool

AbstractLogVisualEditingTool.setPosition

▸ setProperties(properties?): DepthShiftingTool

Sets all the properties pertaining to this object

DepthShiftingTool

this

AbstractLogVisualEditingTool.setProperties

▸ setProperty(name, value): DepthShiftingTool

Sets dynamic property by name

DepthShiftingTool

this

AbstractLogVisualEditingTool.setProperty

▸ setRange(limits): DepthShiftingTool

Sets depth range model limits

DepthShiftingTool

this

▸ setShape(curve): DepthShiftingTool

Sets the shape which this tool has to manipulate and calculate its handles from.

DepthShiftingTool

AbstractLogVisualEditingTool.setShape

▸ setShowGhost(showGhost): DepthShiftingTool

Sets the flag defining if a ghost should be moved instead of the actual handle

DepthShiftingTool

AbstractLogVisualEditingTool.setShowGhost

▸ setSilent(bool): DepthShiftingTool

Set silent mode

DepthShiftingTool

this

AbstractLogVisualEditingTool.setSilent

▸ setSlotEnabled(eventName, value, target?): DepthShiftingTool

Sets slot enabled

DepthShiftingTool

AbstractLogVisualEditingTool.setSlotEnabled

▸ setSlots(slots?, merge?): DepthShiftingTool

Sets new slots.

Example

const slots = {
'pointerdown': (event: EventArgs) => {
// event is an instance of @int/geotoolkit/controls/tools/EventArgs
...
}
};
tool.setSlots(slots);

DepthShiftingTool

this

AbstractLogVisualEditingTool.setSlots

▸ setTouchRadius(radius): DepthShiftingTool

Sets device radius for touch events

DepthShiftingTool

this

AbstractLogVisualEditingTool.setTouchRadius

▸ Protected start(eventArgs?): DepthShiftingTool

start

DepthShiftingTool

AbstractLogVisualEditingTool.start

▸ Protected stop(): DepthShiftingTool

stop

DepthShiftingTool

AbstractLogVisualEditingTool.stop

▸ toggle(): DepthShiftingTool

switch enable state to opposite state

DepthShiftingTool

AbstractLogVisualEditingTool.toggle

▸ update(): void

Updates tool

void

AbstractLogVisualEditingTool.update

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractLogVisualEditingTool.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractLogVisualEditingTool.clientToCanvas

▸ Static getClassName(): string

string

AbstractLogVisualEditingTool.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractLogVisualEditingTool.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractLogVisualEditingTool.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractLogVisualEditingTool.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractLogVisualEditingTool.lock

▸ Static mapDepths(limits, mapping, depths): number[]

Interpolate specified depths with specified depth mappings array

number[]

interpolated depths array

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractLogVisualEditingTool.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractLogVisualEditingTool.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractLogVisualEditingTool.unlock