Class Measure

Manages measure flow and gizmos

Hierarchy

Measure

Implements

IMeasure

Index

Constructors

Accessors

endPoint measurement stage startPoint

Methods

abort clear onFirstClick onMouseIdle onMouseMove onSecondClick start

Constructors

constructor

new Measure(viewer: Viewer): Measure
Parameters
- viewer: Viewer
Returns Measure
- Defined in src/viewer/gizmos/measure/measure.ts:101

Accessors

endPoint

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

Returns THREE.Vector3
Implementation of IMeasure.endPoint
- Defined in src/viewer/gizmos/measure/measure.ts:83

measurement

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

Returns THREE.Vector3
Implementation of IMeasure.measurement
- Defined in src/viewer/gizmos/measure/measure.ts:90

stage

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

Returns MeasureStage
Implementation of IMeasure.stage
- Defined in src/viewer/gizmos/measure/measure.ts:97

startPoint

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

Returns THREE.Vector3
Implementation of IMeasure.startPoint
- Defined in src/viewer/gizmos/measure/measure.ts:76

Methods

abort

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

Returns void
Implementation of IMeasure.abort
- Defined in src/viewer/gizmos/measure/measure.ts:206

clear

clear(): void
Clears meshes.

Returns void
Implementation of IMeasure.clear
- Defined in src/viewer/gizmos/measure/measure.ts:218

onFirstClick

onFirstClick(action: InputAction): void
Should be private.
Parameters
- action: InputAction
Returns void
- Defined in src/viewer/gizmos/measure/measure.ts:138

onMouseIdle

onMouseIdle(action: InputAction): void
Should be private.
Parameters
- action: InputAction
Returns void
- Defined in src/viewer/gizmos/measure/measure.ts:157

onMouseMove

onMouseMove(): void
Should be private.

Returns void
- Defined in src/viewer/gizmos/measure/measure.ts:150

onSecondClick

onSecondClick(action: InputAction): boolean
Should be private.
Parameters
- action: InputAction
Returns boolean
- Defined in src/viewer/gizmos/measure/measure.ts:180

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>
Implementation of IMeasure.start
- Defined in src/viewer/gizmos/measure/measure.ts:111

Generated using TypeDoc