Class Measure

Manages measure flow and gizmos

Implements

IMeasure

Index

Constructors

Accessors

endPoint measurement stage startPoint

Methods

abort clear onFirstClick onSecondClick start

Constructors

constructor

new Measure(viewer: Core.Webgl.Viewer): Measure
Parameters
- viewer: Core.Webgl.Viewer
Returns Measure
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:103

Accessors

endPoint

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

Returns Vector3
Implementation of IMeasure.endPoint
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:85

measurement

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

Returns Vector3
Implementation of IMeasure.measurement
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:92

stage

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

Returns MeasureStage
Implementation of IMeasure.stage
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:99

startPoint

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

Returns Vector3
Implementation of IMeasure.startPoint
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:78

Methods

abort

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

Returns void
Implementation of IMeasure.abort
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:202

clear

clear(): void
Clears meshes.

Returns void
Implementation of IMeasure.clear
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:214

onFirstClick

onFirstClick(hit: Core.Webgl.IRaycastResult): void
Should be private.
Parameters
- hit: Core.Webgl.IRaycastResult
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:148

onSecondClick

onSecondClick(hit: Core.Webgl.IRaycastResult): boolean
Should be private.
Parameters
- hit: Core.Webgl.IRaycastResult
Returns boolean
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:181

start

start(): 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.

Returns Promise<void>
Implementation of IMeasure.start
- Defined in src/vim-web/core-viewers/webgl/viewer/gizmos/measure/measure.ts:113