Interface IMeasure

Interacts with the measure tool.

Hierarchy

IMeasure

Implemented by

Measure

Index

Accessors

endPoint measurement stage startPoint

Methods

abort clear start

Accessors

endPoint

get endPoint(): Vector3
End point of the current measure or undefined if no active measure.

Returns Vector3
- Defined in src/vim-webgl-viewer/gizmos/measure/measure.ts:24

measurement

get measurement(): Vector3
Vector from start to end of the current measure or undefined if no active measure.

Returns Vector3
- Defined in src/vim-webgl-viewer/gizmos/measure/measure.ts:29

stage

get stage(): MeasureStage
Stage of the current measure or undefined if no active measure.

Returns MeasureStage
- Defined in src/vim-webgl-viewer/gizmos/measure/measure.ts:34

startPoint

get startPoint(): Vector3
Start point of the current measure or undefined if no active measure.

Returns Vector3
- Defined in src/vim-webgl-viewer/gizmos/measure/measure.ts:19

Methods

abort

abort(): void
Aborts the current measure flow, fails the related promise.

Returns void
- Defined in src/vim-webgl-viewer/gizmos/measure/measure.ts:47

clear

clear(): void
Clears meshes.

Returns void
- Defined in src/vim-webgl-viewer/gizmos/measure/measure.ts:52

start

start(onProgress?: (() => void)): Promise<void>
Starts a new measure flow where the two next click are overriden. Currently running flow if any will be aborted. Promise is resolved if flow is succesfully completed, rejected otherwise. Do not override viewer.onMouseClick while this flow is active.
Parameters
- Optional onProgress: (() => void)
  - - (): void
    - Returns void
Returns Promise<void>
- Defined in src/vim-webgl-viewer/gizmos/measure/measure.ts:42

Generated using TypeDoc