worldwind-ui API / worldwind-kit / MeasureTool

Class: MeasureTool

Defined in: kit/src/measure.ts:60

Click-to-measure distances and areas. Points are added by clicking the globe while the tool is active; the line and vertex markers live in the tool's own layer. *

Example

const measure = new MeasureTool(globe);
measure.subscribe((state) => console.log(formatDistance(state.lengthMeters)));
measure.start(); // clicks on the globe now add points

Constructors

Constructor

new MeasureTool(globe, options?): MeasureTool

Defined in: kit/src/measure.ts:71

Parameters

globe

GlobeController

options?

MeasureToolOptions = {}

Returns

MeasureTool

Properties

layer

readonly layer: WWRenderableLayer

Defined in: kit/src/measure.ts:61

Accessors

state

Get Signature

get state(): MeasurementState

Defined in: kit/src/measure.ts:81

Current measurement; the same object until something changes.

Returns

MeasurementState

Methods

add()

add(point): void

Defined in: kit/src/measure.ts:104

Parameters

point

LatLonAlt

Returns

void

---

clear()

clear(): void

Defined in: kit/src/measure.ts:115

Returns

void

---

destroy()

destroy(): void

Defined in: kit/src/measure.ts:126

Stops measuring and removes the tool's layer from the globe.

Returns

void

---

start()

start(): void

Defined in: kit/src/measure.ts:85

Returns

void

---

stop()

stop(): void

Defined in: kit/src/measure.ts:93

Returns

void

---

subscribe()

subscribe(listener): Unsubscribe

Defined in: kit/src/measure.ts:121

Parameters

listener

(state) => void

Returns

Unsubscribe

---

toggle()

toggle(): void

Defined in: kit/src/measure.ts:99

Returns

void

---

undo()

undo(): void

Defined in: kit/src/measure.ts:109

Returns

void