/
navigation.ts
502 lines (404 loc) · 16.7 KB
/
navigation.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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
/* spellchecker: disable */
import { vec2 } from 'gl-matrix';
import { Camera } from './camera';
import { EventHandler } from './eventhandler';
import { PointerLock } from './pointerlock';
import { Invalidate } from './renderer';
import { LogLevel } from './auxiliaries';
import { FirstPersonModifier } from './firstpersonmodifier';
import { PanModifier } from './panmodifier';
import { PinchZoomModifier } from './pinchzoommodifier';
import { TrackballModifier } from './trackballmodifier';
import { TurntableModifier } from './turntablemodifier';
import { auxiliaries } from './webgl-operate.slim';
import { EventProvider } from './eventhandler'
import { WheelZoomModifier } from './wheelzoommodifier';
/* spellchecker: enable */
/**
* This navigation is merely a design template/recipe for more refined, specialized navigation and provides some basic,
* commonly used camera modifier such as turntable, first-person, as well as trackball. This implementation is also
* unfinished and will be continued as soon as possible (e.g., first-person navigation is not usable for now).
* @todo - Refine and comment this class to be usable at least as common/most-basic navigation auxiliary.
*/
export class Navigation {
/**
* The navigation's invalidation callback. This should usually be setup by the owning renderer and invoke the
* same callback the renderer has been given by the canvas. This invalidation is required, when continuous
* rendering is not present, events might cause need for new rendering requests.
*/
protected _invalidate: Invalidate;
/** @see {@link camera} */
protected _camera: Camera;
/**
* Currently active metaphor.
*/
protected _rotationMetaphor: Navigation.RotationMetaphor;
/**
* Identifies the active camera modifier.
*/
protected _mode: Navigation.Modes | undefined;
/**
* Specifies, whether or not rotation mode should be invoked on any move event, regardless of buttons.
*/
protected _alwaysRotateOnMove = false;
/**
* First person camera modifier.
*/
protected _firstPerson: FirstPersonModifier | undefined;
/**
* Trackball camera modifier.
*/
protected _trackball: TrackballModifier | undefined;
/**
* Turntable camera modifier.
*/
protected _turntable: TurntableModifier | undefined;
/**
* Pan camera modifier.
*/
protected _pan: PanModifier | undefined;
/**
* Pinch camera modifier.
*/
protected _pinch: PinchZoomModifier | undefined;
/**
* Wheel zoom modifier.
*/
protected _wheelZoom: WheelZoomModifier | undefined;
/**
* Even handler used to forward/map events to specific camera modifiers.
*/
protected _eventHandler: EventHandler;
/**
* This keeps track of all events that are currently interacting with the canvas.
* It maps from pointer id to the currecnt position.
*/
protected _activeEvents: Map<number, PointerEvent>;
/**
* Keep track of the latest interaction in order to allow a cooldown before the next
* interaction is allowed.
*/
protected _lastInteractionTime: number;
constructor(
invalidate: Invalidate,
eventProvider: EventProvider) {
this._invalidate = invalidate;
/* Create event handler that listens to mouse events. */
this._eventHandler = new EventHandler(invalidate, eventProvider);
/* Listen to pointer events. */
this._eventHandler.pushPointerDownHandler((latests: Array<PointerEvent>, previous: Array<PointerEvent>) =>
this.onPointerDown(latests, previous));
this._eventHandler.pushPointerUpHandler((latests: Array<PointerEvent>, previous: Array<PointerEvent>) =>
this.onPointerUp(latests, previous));
this._eventHandler.pushPointerEnterHandler((latests: Array<PointerEvent>, previous: Array<PointerEvent>) =>
this.onPointerEnter(latests, previous));
this._eventHandler.pushPointerLeaveHandler((latests: Array<PointerEvent>, previous: Array<PointerEvent>) =>
this.onPointerLeave(latests, previous));
this._eventHandler.pushPointerMoveHandler((latests: Array<PointerEvent>, previous: Array<PointerEvent>) =>
this.onPointerMove(latests, previous));
this._eventHandler.pushPointerCancelHandler((latests: Array<PointerEvent>, previous: Array<PointerEvent>) =>
this.onPointerCancel(latests, previous));
this._eventHandler.pushMouseWheelHandler((latests: Array<WheelEvent>, previous: Array<WheelEvent>) =>
this.onWheel(latests, previous));
/* Explicitly use the setter here to create the appropriate modifier. */
this.rotationMetaphor = Navigation.RotationMetaphor.Turntable;
this._pan = new PanModifier();
this._pinch = new PinchZoomModifier();
this._wheelZoom = new WheelZoomModifier();
this._activeEvents = new Map();
}
/**
* Resolves the event to camera modifier mapping by returning the responsible camera modifier.
* @param event - Event to retrieve navigation mode for.
*/
protected mode(): Navigation.Modes | undefined {
const events = Array.from(this._activeEvents.values());
const primaryEvent = this.getPrimaryEvent(events);
if (primaryEvent === undefined) {
auxiliaries.log(LogLevel.Warning, 'No primary pointer event detected in Navigation::mode.');
return;
}
const isMouseEvent = primaryEvent.pointerType === 'mouse';
const isTouchEvent = primaryEvent.pointerType === 'touch' || primaryEvent.pointerType === 'pen';
const isPrimaryButtonDown = primaryEvent.buttons & 1;
const isShiftKeyDown = primaryEvent.shiftKey;
// const touchEvent = event as TouchEvent;
// let isTouchEvent = false;
// if (touchEvent !== undefined) {
// isTouchEvent = touchEvent.touches !== undefined && touchEvent.touches.length > 0;
// }
const isPointerLockedRotate = PointerLock.active() && this._alwaysRotateOnMove;
const numPointers = this._activeEvents.size;
const isMouseRotate = isMouseEvent && isPrimaryButtonDown && numPointers === 1;
const isTouchRotate = isTouchEvent && numPointers === 1;
const isMousePan = isMouseEvent && isPrimaryButtonDown && isShiftKeyDown && numPointers === 1;
const isMultiTouch = isTouchEvent && numPointers === 2;
if (isPointerLockedRotate) {
return Navigation.Modes.Rotate;
}
if (isMousePan) {
return Navigation.Modes.Pan;
} else if (isMultiTouch) {
return Navigation.Modes.MultiTouch;
} else if (isMouseRotate || isTouchRotate) {
return Navigation.Modes.Rotate;
}
return undefined;
}
protected resolveMultiTouch(): Navigation.Modes | undefined {
if (this._activeEvents.size < 2) {
auxiliaries.log(LogLevel.Warning,
'MultiTouch resolution was canceled because less than two touches were detected.');
return undefined;
}
const events = Array.from(this._activeEvents.values());
const direction1 = vec2.fromValues(events[0].movementX, events[0].movementY);
const direction2 = vec2.fromValues(events[1].movementX, events[1].movementY);
if (vec2.length(direction1) === 0 || vec2.length(direction2) === 0) {
return Navigation.Modes.Zoom;
}
vec2.normalize(direction1, direction1);
vec2.normalize(direction2, direction2);
const cosAngle = vec2.dot(direction1, direction2);
const panThreshold = 0.2;
if (cosAngle > panThreshold) {
return Navigation.Modes.Pan;
} else {
return Navigation.Modes.Zoom;
}
}
protected rotate(start: boolean): void {
if (this._activeEvents.size !== 1) {
auxiliaries.log(LogLevel.Info,
'Rotate event was canceled because less or more than two pointers were detected.');
return;
}
const events = Array.from(this._activeEvents.values());
const point = this._eventHandler.offsets(events[0])[0];
switch (this._rotationMetaphor) {
case Navigation.RotationMetaphor.FirstPerson:
const firstPerson = this._firstPerson as FirstPersonModifier;
let movement: vec2 | undefined;
if (PointerLock.active() && event instanceof MouseEvent) {
movement = vec2.fromValues((event as MouseEvent).movementX, (event as MouseEvent).movementY);
}
start ? firstPerson.initiate(point) : firstPerson.process(point, movement);
break;
case Navigation.RotationMetaphor.Trackball:
const trackball = this._trackball as TrackballModifier;
start ? trackball.initiate(point) : trackball.process(point);
break;
case Navigation.RotationMetaphor.Turntable:
const turntable = this._turntable as TurntableModifier;
start ? turntable.initiate(point) : turntable.process(point);
break;
default:
break;
}
}
protected pan(start: boolean): void {
const events = Array.from(this._activeEvents.values());
const event = this.getPrimaryEvent(events);
if (event === undefined) {
auxiliaries.log(LogLevel.Warning,
'Pan event was canceled because no primary event was detected.');
return;
}
const point = this._eventHandler.offsets(event)[0];
const pan = this._pan as PanModifier;
start ? pan.initiate(point) : pan.process(point);
}
protected pinch(start: boolean): void {
if (this._activeEvents.size !== 2) {
auxiliaries.log(LogLevel.Info,
'Pinch event was canceled because less or more than two pointers were detected.');
return;
}
const events = Array.from(this._activeEvents.values());
const point1 = this._eventHandler.offsets(events[0])[0];
const point2 = this._eventHandler.offsets(events[1])[0];
const pinch = this._pinch as PinchZoomModifier;
start ? pinch.initiate(point1, point2) : pinch.process(point1, point2);
}
protected getPrimaryEvent(events: Array<PointerEvent>): PointerEvent | undefined {
for (const event of events) {
if (event.isPrimary) {
return event;
}
}
return undefined;
}
protected onPointerDown(latests: Array<PointerEvent>, previous: Array<PointerEvent>): void {
for (const event of latests) {
this._activeEvents.set(event.pointerId, event);
}
this._mode = this.mode();
switch (this._mode) {
case Navigation.Modes.Rotate:
this.rotate(true);
break;
case Navigation.Modes.Pan:
this.pan(true);
break;
case Navigation.Modes.Zoom:
this.pinch(true);
break;
default:
break;
}
}
protected onPointerUp(latests: Array<PointerEvent>, previous: Array<PointerEvent>): void {
for (const pointer of latests) {
this._activeEvents.delete(pointer.pointerId);
}
}
protected onPointerEnter(latests: Array<PointerEvent>, previous: Array<PointerEvent>): void { }
protected onPointerLeave(latests: Array<PointerEvent>, previous: Array<PointerEvent>): void {
for (const pointer of latests) {
this._activeEvents.delete(pointer.pointerId);
}
}
protected onPointerCancel(latests: Array<PointerEvent>, previous: Array<PointerEvent>): void {
for (const pointer of latests) {
this._activeEvents.delete(pointer.pointerId);
}
}
protected onPointerMove(latests: Array<PointerEvent>, previous: Array<PointerEvent>): void {
for (const event of latests) {
this._activeEvents.set(event.pointerId, event);
}
if (this._mode === undefined) {
return;
}
const events = Array.from(this._activeEvents.values());
const primaryEvent = this.getPrimaryEvent(events);
/**
* Update the mode for every movement when using a mouse. This is necessary since mouse events do not trigger
* 'pointerup' events, so we need to figure out when the primary button is released manually
*/
if (primaryEvent?.pointerType === 'mouse') {
this._mode = this.mode();
}
/**
* Handle the case where this is the first movement of a multi-touch gesture. We need to find out which
* kind of gesture is executed.
*/
let modeUpdated = false;
if (this._mode === Navigation.Modes.MultiTouch) {
this._mode = this.resolveMultiTouch();
modeUpdated = true;
}
switch (this._mode) {
case Navigation.Modes.Rotate:
this.rotate(modeUpdated);
break;
case Navigation.Modes.Pan:
this.pan(modeUpdated);
break;
case Navigation.Modes.Zoom:
this.pinch(modeUpdated);
break;
default:
break;
}
this._lastInteractionTime = performance.now();
}
protected onWheel(latests: Array<WheelEvent>, previous: Array<WheelEvent>): void {
const event = latests[0];
this._wheelZoom?.process(event.deltaY);
}
/**
* Update should invoke navigation specific event processing. When using, e.g., an event handler, the event handlers
* update method should be called in order to have navigation specific event processing invoked.
*/
update(): void {
this._eventHandler.update();
}
/**
* The camera that is to be modified in response to various events.
*/
set camera(camera: Camera) {
this._camera = camera;
if (this._firstPerson) {
this._firstPerson.camera = camera;
}
if (this._trackball) {
this._trackball.camera = camera;
}
if (this._turntable) {
this._turntable.camera = camera;
}
if (this._pan) {
this._pan.camera = camera;
}
if (this._pinch) {
this._pinch.camera = camera;
}
if (this._wheelZoom) {
this._wheelZoom.camera = camera;
}
}
/**
* Configure this navigation's metaphor.
*/
set rotationMetaphor(metaphor: Navigation.RotationMetaphor) {
if (this._rotationMetaphor === metaphor) {
return;
}
this._firstPerson = undefined;
this._trackball = undefined;
this._turntable = undefined;
this._eventHandler.exitPointerLock(); /* Might be requested (and active) from FirstPerson or Flight. */
this._alwaysRotateOnMove = false;
this._rotationMetaphor = metaphor;
switch (this._rotationMetaphor) {
case Navigation.RotationMetaphor.FirstPerson:
this._eventHandler.requestPointerLock();
this._alwaysRotateOnMove = true;
this._firstPerson = new FirstPersonModifier();
this._firstPerson.camera = this._camera;
break;
case Navigation.RotationMetaphor.Trackball:
this._trackball = new TrackballModifier();
this._trackball.camera = this._camera;
break;
case Navigation.RotationMetaphor.Turntable:
this._turntable = new TurntableModifier();
this._turntable.camera = this._camera;
break;
default:
break;
}
this._invalidate(true);
}
get rotationMetaphor(): Navigation.RotationMetaphor {
return this._rotationMetaphor;
}
}
export namespace Navigation {
/**
* Navigation modes used for identification of the current navigation intend, which is derived based on the event
* types or gestures, regardless of the active navigation metaphor and its constraints.
*/
export enum Modes {
Move,
Pan,
/**
* MultiTouch is used when interaction with two fingers was initiated but it is not clear yet what
* interaction the user intends
*/
MultiTouch,
Rotate,
Zoom,
ZoomStep,
}
/**
* Navigation metaphors supported by the default navigation implementation.
*/
export enum RotationMetaphor {
FirstPerson = 'firstperson',
Flight = 'flight',
Trackball = 'trackball',
Turntable = 'turntable',
}
}