-
Notifications
You must be signed in to change notification settings - Fork 18
/
MeasurementTool.ts
440 lines (399 loc) · 13.9 KB
/
MeasurementTool.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/*!
* Copyright 2022 Cognite AS
*/
import { Cognite3DViewer } from '@reveal/api';
import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
import { assertNever, DisposedDelegate, EventTrigger } from '@reveal/utilities';
import * as THREE from 'three';
import {
MeasurementAddedDelegate,
MeasurementStartedDelegate,
MeasurementEndedDelegate,
MeasurementOptions
} from './types';
import { MeasurementManager, Measurement } from './MeasurementManager';
import { MeasurementLabels } from './MeasurementLabels';
import { HtmlOverlayTool, HtmlOverlayToolOptions } from '../HtmlOverlay/HtmlOverlayTool';
import rulerSvg from '!!raw-loader!./styles/ruler.svg';
type MeasurementEvents = 'added' | 'started' | 'ended' | 'disposed';
/**
* Enables {@see Cognite3DViewer} to perform a point to point measurement.
* This can be achieved by selecting a point on the 3D Object and drag the pointer to
* required point to get measurement of the distance.
* The tools default measurement is in "Meters" as supported in Reveal, but it also provides
* user to customise the measuring units based on their convinience with the callback.
*
* @example
* ```js
* const measurementTool = new MeasurementTool(viewer);
* measurementTool.enterMeasurementMode();
* // ...
* measurementTool.exitMeasurementMode();
*
* // detach the tool from the viewer
* measurementTool.dispose();
* ```
* @example
* ```jsx runnable
* const measurementTool = new MeasurementTool(viewer, {distanceToLabelCallback: (distanceInMeters) => {
* // 1 meters = 3.281 feet
* const distancesInFeet = distanceInMeters * 3.281;
* return { distanceInMeters: distancesInFeet, units: 'ft'};
* }});
* measurementTool.enterMeasurementMode();
```
*/
export class MeasurementTool extends Cognite3DViewerToolBase {
/**
* Returns measurement mode state, is measurement mode started or ended.
*/
get isInMeasurementMode(): boolean {
return this._measurementMode;
}
private _options: Required<MeasurementOptions>;
private readonly _viewer: Cognite3DViewer;
private readonly _geometryGroup = new THREE.Group();
private readonly _measurements: MeasurementManager[];
private _activeMeasurement: MeasurementManager | undefined;
private readonly _htmlOverlay: HtmlOverlayTool;
private _measurementMode: boolean;
private readonly _handleLabelClustering = this.createCombineClusterElement.bind(this);
private readonly _handlePointerClick = this.onPointerClick.bind(this);
private readonly _handlePointerMove = this.onPointerMove.bind(this);
private readonly _handleMeasurementCancel = this.onKeyDown.bind(this);
private readonly _events = {
measurementAdded: new EventTrigger<MeasurementAddedDelegate>(),
measurementStarted: new EventTrigger<MeasurementStartedDelegate>(),
measurementEnded: new EventTrigger<MeasurementEndedDelegate>(),
disposed: new EventTrigger<DisposedDelegate>()
};
private readonly _overlayOptions: HtmlOverlayToolOptions = {
clusteringOptions: { mode: 'overlapInScreenSpace', createClusterElementCallback: this._handleLabelClustering }
};
private static readonly defaultLineOptions: Required<MeasurementOptions> = {
distanceToLabelCallback: d => MeasurementTool.metersLabelCallback(d),
lineWidth: 0.01,
color: new THREE.Color(0xff8746)
};
constructor(viewer: Cognite3DViewer, options?: MeasurementOptions) {
super();
this._viewer = viewer;
this._options = {
...MeasurementTool.defaultLineOptions,
...options
};
this._measurements = [];
this._measurementMode = false;
this._htmlOverlay = new HtmlOverlayTool(this._viewer, this._overlayOptions);
this._geometryGroup.name = MeasurementTool.name;
this._viewer.addObject3D(this._geometryGroup);
}
/**
* Triggered when the tool is disposed. Listeners should clean up any
* resources held and remove the reference to the tool.
* @example
* ```js
* measurementTool.on('disposed', onMeasurementDispose);
* ```
*/
on(event: 'disposed', callback: DisposedDelegate): void;
/**
* Triggered when a measurement is added into the Cognite3DViewer.
* @example
* ```js
* measurementTool.on('added', onMeasurementAdded);
* ```
*/
on(event: 'added', callback: MeasurementAddedDelegate): void;
/**
* Triggered when a measurement mode is started.
* @example
* ```js
* measurementTool.on('started', onMeasurementStarted);
* ```
*/
on(event: 'started', callback: MeasurementStartedDelegate): void;
/**
* Triggered when measurement mode is ended.
* @example
* ```js
* measurementTool.on('ended', onMeasurementEnded);
* ```
*/
on(event: 'ended', callback: MeasurementEndedDelegate): void;
/**
* Subscribe to the Measurement events
* @param event `MeasurementEvents` event
* @param callback Callback to measurements events
*/
on(
event: MeasurementEvents,
callback: MeasurementAddedDelegate | MeasurementStartedDelegate | MeasurementEndedDelegate | DisposedDelegate
): void {
switch (event) {
case 'added':
this._events.measurementAdded.subscribe(callback as MeasurementAddedDelegate);
break;
case 'started':
this._events.measurementStarted.subscribe(callback as MeasurementStartedDelegate);
break;
case 'ended':
this._events.measurementEnded.subscribe(callback as MeasurementEndedDelegate);
break;
case 'disposed':
this._events.disposed.subscribe(callback as DisposedDelegate);
break;
default:
assertNever(event, `Unsupported event: '${event}'`);
}
}
/**
* @example
* ```js
* measurementTool.off('disposed', onMeasurementDispose);
* ```
*/
off(event: 'disposed', callback: DisposedDelegate): void;
/**
* @example
* ```js
* measurementTool.off('added', onMeasurementAdded);
* ```
*/
off(event: 'added', callback: MeasurementAddedDelegate): void;
/**
* @example
* ```js
* measurementTool.off('started', onMeasurementStarted);
* ```
*/
off(event: 'started', callback: MeasurementStartedDelegate): void;
/**
* @example
* ```js
* measurementTool.off('ended', onMeasurementEnded);
* ```
*/
off(event: 'ended', callback: MeasurementEndedDelegate): void;
/**
* Unsubscribe to the Measurement event
* @param event `MeasurementEvents` event
* @param callback Callback to measurements events
*/
off(
event: MeasurementEvents,
callback: MeasurementAddedDelegate | MeasurementStartedDelegate | MeasurementEndedDelegate | DisposedDelegate
): void {
switch (event) {
case 'added':
this._events.measurementAdded.unsubscribe(callback as MeasurementAddedDelegate);
break;
case 'started':
this._events.measurementStarted.unsubscribe(callback as MeasurementStartedDelegate);
break;
case 'ended':
this._events.measurementEnded.unsubscribe(callback as MeasurementEndedDelegate);
break;
case 'disposed':
this._events.disposed.unsubscribe(callback as DisposedDelegate);
break;
default:
assertNever(event, `Unsupported event: '${event}'`);
}
}
/**
* Enter into point to point measurement mode.
*/
enterMeasurementMode(): void {
if (this._measurementMode) {
throw new Error('Measurement mode is active, call exitMeasurementMode()');
}
this._viewer.on('click', this._handlePointerClick);
this._events.measurementStarted.fire();
this._measurementMode = true;
}
/**
* Exit measurement mode.
*/
exitMeasurementMode(): void {
if (!this._measurementMode) {
throw new Error('Measurement mode is not active, call enterMeasurementMode()');
}
this.cancelActiveMeasurement();
this._viewer.off('click', this._handlePointerClick);
this._events.measurementEnded.fire();
this._measurementMode = false;
}
/**
* Removes a measurement from the Cognite3DViewer.
* @param measurement Measurement to be removed from Cognite3DViewer.
*/
removeMeasurement(measurement: Measurement): void {
const index = this._measurements.findIndex(
measurementManager => measurementManager.getMeasurement() === measurement
);
if (index === -1) {
throw new Error('Measurement not found');
}
this._measurements[index].removeMeasurement();
this._measurements.splice(index, 1);
this._viewer.requestRedraw();
}
/**
* Removes all measurements from the Cognite3DViewer.
*/
removeAllMeasurements(): void {
//clear all mesh, geometry & labels.
this._measurements.forEach(measurement => {
measurement.removeMeasurement();
});
this._measurements.splice(0);
this._viewer.requestRedraw();
}
/**
* Sets the visiblity of labels in the Measurement.
* @param enable
*/
setMeasurementLabelsVisible(enable: boolean): void {
this._htmlOverlay.visible(enable);
}
/**
* Sets Measurement line width, color and label units value for the next measurment.
* @param options MeasurementOptions to set line width, color and callback for custom operation on measurement labels.
*/
setLineOptions(options: MeasurementOptions): void {
this._options = {
...this._options,
...options
};
}
/**
* Update selected line width.
* @param measurement Measurement to be updated.
* @param lineWidth Width of the measuring line.
*/
updateLineWidth(measurement: Measurement, lineWidth: number): void {
const index = this._measurements.findIndex(
measurementManager => measurementManager.getMeasurement() === measurement
);
if (index === -1) {
throw new Error('Measurement not found');
}
this._measurements[index].updateLineWidth(lineWidth);
this._viewer.requestRedraw();
}
/**
* Update selected line color.
* @param measurement Measurement to be updated.
* @param color Color of the measuring line.
*/
updateLineColor(measurement: Measurement, color: THREE.Color): void {
const index = this._measurements.findIndex(
measurementManager => measurementManager.getMeasurement() === measurement
);
if (index === -1) {
throw new Error('Measurement not found');
}
this._measurements[index].updateLineColor(color);
this._viewer.requestRedraw();
}
/**
* Get all measurements from {@link Cognite3DViewer}.
* @returns Array of Measurements containing Id, start point, end point & measured distance.
*/
getAllMeasurements(): Measurement[] {
return this._measurements.map(measurement => measurement.getMeasurement());
}
/**
* Dispose Measurement Tool.
*/
dispose(): void {
this.removeAllMeasurements();
this.exitMeasurementMode();
this._activeMeasurement?.removeMeasurement();
this._htmlOverlay.dispose();
this._geometryGroup.clear();
this._viewer.removeObject3D(this._geometryGroup);
this._events.measurementAdded.unsubscribeAll();
this._events.measurementStarted.unsubscribeAll();
this._events.measurementEnded.unsubscribeAll();
super.dispose();
}
private async onPointerClick(event: { offsetX: number; offsetY: number }): Promise<void> {
const { offsetX, offsetY } = event;
const intersection = await this._viewer.getIntersectionFromPixel(offsetX, offsetY);
if (!intersection) {
return;
}
if (!this._activeMeasurement) {
const camera = this._viewer.getCamera();
const domElement = this._viewer.domElement;
this._activeMeasurement = new MeasurementManager(
domElement,
camera,
this._geometryGroup,
this._options,
this._htmlOverlay,
intersection.point
);
this._viewer.domElement.addEventListener('pointermove', this._handlePointerMove);
window.addEventListener('keydown', this._handleMeasurementCancel);
} else {
this._activeMeasurement.endMeasurement(intersection.point);
this._measurements.push(this._activeMeasurement);
this._activeMeasurement = undefined;
// To avoid issue when exiting measurement mode when a measurement 'added' event called
this._events.measurementAdded.fire(this._measurements[this._measurements.length - 1].getMeasurement());
this._viewer.domElement.removeEventListener('pointermove', this._handlePointerMove);
window.removeEventListener('keydown', this._handleMeasurementCancel);
}
this._viewer.requestRedraw();
}
private onPointerMove(event: { offsetX: number; offsetY: number }) {
if (this._activeMeasurement) {
this._activeMeasurement!.update(event);
this._viewer.requestRedraw();
}
}
/**
* Create and return combine ruler icon as HTMLDivElement.
* @returns HTMLDivElement.
*/
private createCombineClusterElement() {
// TODO 2022-07-05 larsmoa: Move all ownership of labels here - currently responsibility is split
// between several classes which is *bad*
// pramodcog: as clustering is related to tool, it would be ideal to have it here.
const combineElement = document.createElement('div');
combineElement.className = MeasurementLabels.stylesId;
combineElement.innerHTML = rulerSvg;
return combineElement;
}
private static metersLabelCallback(distanceInMeters: number): string {
return `${distanceInMeters.toFixed(2)} m`;
}
/**
* To cancel an active measurement `Escape` key is processed and remove all its related data & events.
* @param event Keyboard event to process for `Escape` key
*/
private onKeyDown(event: KeyboardEvent) {
if (event.metaKey || event.altKey || event.ctrlKey) {
return;
}
if (event.key === 'Escape') {
//Cancel active measurement
this.cancelActiveMeasurement();
event.preventDefault();
}
}
/**
* Cancel the active measurement.
*/
private cancelActiveMeasurement() {
if (this._activeMeasurement) {
this._activeMeasurement.removeMeasurement();
this._activeMeasurement = undefined;
this._viewer.requestRedraw();
this._viewer.domElement.removeEventListener('pointermove', this._handlePointerMove);
}
}
}