-
Notifications
You must be signed in to change notification settings - Fork 190
/
Copy pathEasyPointers.ts
1840 lines (1683 loc) · 80.5 KB
/
EasyPointers.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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) John Nesky and contributing authors, distributed under the MIT license, see accompanying the LICENSE.md file.
declare global {
// Old versions of the TypeScript standard types don't have these properties.
// TODO: Update my TypeScript version and remove this.
interface CSSStyleDeclaration {
contentVisibility: string;
zoom: string;
}
interface PointerEvent<T = any> {
pointers?: EasyPointers;
pointer?: Pointer<T>;
}
}
export interface EasyPointersOptions {
listenForTheseButtons?: Iterable<`${PointerButton}`>,
listenForMultipleButtonsDown?: boolean,
listenForMultiplePointers?: boolean,
listenForPossiblyAccidentalPointers?: boolean,
preventTouchGestureScrolling?: boolean,
preventTextSelection?: boolean,
preventContextMenu?: boolean,
preventMiddleButtonScrolling?: boolean,
moveMinDistance?: number,
holdStillMinMillis?: number,
deferInitialEvents?: boolean,
stopEventsAfterTargetIsRemovedFromLayout?: boolean,
prioritizeTargetOverNeighborsOnTouchScreen?: boolean,
}
function verifyBooleanOption(options: EasyPointersOptions, name: keyof EasyPointersOptions, defaultValue: boolean): boolean {
const value: any = options[name];
if (typeof value != "boolean" && value !== undefined) {
throw new Error(`EasyPointers: The ${name} option, if provided, should be a boolean value.`);
}
return !!(value ?? defaultValue);
}
function elementIsInLayout(element: HTMLElement | SVGElement): boolean {
// Returns true if the element is in the DOM, does not have display:none,
// and is not otherwise removed from layout.
return element.getClientRects().length > 0;
}
export class EasyPointers<UserData = unknown> {
private static readonly _managedTargets: WeakSet<HTMLElement | SVGElement> = new WeakSet();
//private static readonly _usingMac: boolean = navigator.userAgent.includes("Macintosh");
public static readonly usingPrimarilyTouchDevice: boolean = matchMedia("(pointer:coarse)").matches;
public deferInitialEvents: boolean;
public preventTouchGestureScrolling: boolean;
public preventTextSelection: boolean;
public preventContextMenu: boolean;
public preventMiddleButtonScrolling: boolean;
public readonly dispose: () => void;
private readonly _target: HTMLElement | SVGElement;
public get target(): HTMLElement | SVGElement { return this._target; }
private readonly _byId: Map<number, _InternalPointer<UserData>> = new Map();
public get byId(): ReadonlyMap<number, Pointer<UserData>> { return this._byId; }
constructor(target: HTMLElement | SVGElement, options: EasyPointersOptions = {}) {
if (!(target instanceof HTMLElement) && !(target instanceof SVGElement)) {
throw new Error("EasyPointers: The target should be an HTMLElement or SVGElement.");
}
if (EasyPointers._managedTargets.has(target)) {
throw new Error("EasyPointers: Cannot register EasyPointers twice for the same target element simultaneously. Try calling dispose() on the first one before creating another.");
}
EasyPointers._managedTargets.add(target);
this._target = target;
if (options.listenForTheseButtons !== undefined &&
typeof options.listenForTheseButtons[Symbol.iterator] != "function")
{
throw new Error("EasyPointers: The listenForTheseButtons option, if provided, should be an iterable object, such as an array, that contains pointer button names.");
}
const listenForTheseButtons: Set<`${PointerButton}`> = new Set(options.listenForTheseButtons ?? [PointerButton.primary]);
for (const button of listenForTheseButtons) {
if (!_buttonSet.has(button)) {
throw new Error("EasyPointers: Unrecognized pointer button name provided: " + button + ". Valid values are: " + [..._buttonSet].map(s => `"${s}"`).join(", "));
}
}
const listenForTheseButtonIndices: Set<_ButtonIndex> = new Set([...listenForTheseButtons].map(button => _indexFromButton.get(button)!));
const listenForTheseButtonsBitmask: number = [...listenForTheseButtons].map(button => _bitmaskFromButton.get(button)!).reduce((acc, bit) => acc | bit, 0);
const listenForMultipleButtonsDown: boolean = verifyBooleanOption(options, "listenForMultipleButtonsDown", false);
const listenForMultiplePointers: boolean = verifyBooleanOption(options, "listenForMultiplePointers", false);
const listenForPossiblyAccidentalPointers: boolean = verifyBooleanOption(options, "listenForPossiblyAccidentalPointers", true);
const moveMinDistance: number = options.moveMinDistance ?? 15; // In my experience, 15 is sufficient for scrolling to trigger (and cancel the pointer) before this threshold is crossed.
if (typeof moveMinDistance != "number" || moveMinDistance < 0 || !Number.isFinite(moveMinDistance)) throw new Error(`EasyPointers: The moveMinDistance option, if provided, should be a nonnegative number value.`);
const holdStillMinMillis: number = options.holdStillMinMillis ?? Infinity;
if (typeof holdStillMinMillis != "number" || holdStillMinMillis <= 0 || Number.isNaN(holdStillMinMillis)) throw new Error(`EasyPointers: The holdStillMinMillis option, if provided, should be a positive number value.`);
this.deferInitialEvents = verifyBooleanOption(options, "deferInitialEvents", false);
this.preventTouchGestureScrolling = verifyBooleanOption(options, "preventTouchGestureScrolling", false);
this.preventTextSelection = verifyBooleanOption(options, "preventTextSelection", listenForTheseButtons.has(PointerButton.primary));
this.preventContextMenu = verifyBooleanOption(options, "preventContextMenu", listenForTheseButtons.has(PointerButton.secondary));
this.preventMiddleButtonScrolling = verifyBooleanOption(options, "preventMiddleButtonScrolling", listenForTheseButtons.has(PointerButton.middle));
const stopEventsAfterTargetIsRemovedFromLayout: boolean = verifyBooleanOption(options, "stopEventsAfterTargetIsRemovedFromLayout", true);
const prioritizeTargetOverNeighborsOnTouchScreen: boolean = verifyBooleanOption(options, "prioritizeTargetOverNeighborsOnTouchScreen", true);
this._latest = new _InternalPointer(this, 0, EasyPointers.usingPrimarilyTouchDevice ? "touch" : "mouse");
this._latest._isInTarget = false;
this._latest._isPresent = false;
this._first = this._latest;
const stop = (event: Event): void => event.stopImmediatePropagation();
const syncEventAndPointer = (event: PointerEvent, pointer: _InternalPointer<UserData>): void => {
// Assign references to the event for convenience if those properties don't already exist.
if (!("pointers" in event)) event.pointers = this;
if (!("pointer" in event)) event.pointer = pointer;
this._latest = pointer;
pointer._lastEvent = event;
this._altKey = event.altKey;
this._ctrlKey = event.ctrlKey;
this._metaKey = event.metaKey;
this._shiftKey = event.shiftKey;
pointer._hasJustEntered = (event.type == "pointerenter");
pointer._hasJustLeft = (event.type == "pointerleave");
pointer._hasJustMoved = (event.type == "pointermove");
pointer._hasJustBecomeDown = (event.type == "pointerdown");
pointer._hasJustBecomeUp = (event.type == "pointerup");
pointer._hasJustBeenCanceled = (event.type == "pointercancel");
}
const resetPresses = (pointer: _InternalPointer): void => {
pointer._gesture = null;
pointer._pressedButtons = _ButtonBitmask.none;
pointer._pressingButtons = _ButtonBitmask.none;
pointer._startedWithButton = _ButtonIndex.none;
pointer._justPressedButton = _ButtonIndex.none;
pointer._justReleasedButton = _ButtonIndex.none;
pointer._startedWithAltKey = false;
pointer._startedWithCtrlKey = false;
pointer._startedWithMetaKey = false;
pointer._startedWithShiftKey = false;
}
const internalEnter = (event: PointerEvent): void => {
// The enter and leave events aren't bubbling, so ordinarily listeners
// can assume that (event.target == event.currentTarget), but this is
// listening in the capture phase so we have to check that manually.
if (event.target != event.currentTarget) return;
// PREVENT EVENT DEFAULTS: N/A
// EVENT STOP CONDITIONS
if (stopEventsAfterTargetIsRemovedFromLayout && !elementIsInLayout(this._target)) {
if (this._byId.has(event.pointerId)) {
this._dispatchPointerLeaveEvent(event.pointerId);
}
return stop(event);
}
if (!listenForMultiplePointers) {
// If only one pointer is allowed at a time, and a different pointer
// is trying to enter, and the new pointer is a different type,
// (e.g. because a mouse present but the user touches the screen)
// and the old pointer is not currently down, then remove the old
// pointer to make room for the new one.
for (const pointer of this._byId.values()) {
if (pointer.id != event.pointerId &&
pointer.type != event.pointerType &&
!pointer._isDown)
{
this._dispatchPointerLeaveEvent(pointer.id);
}
}
}
if (!listenForMultiplePointers && this._byId.size > 0) return stop(event);
if (!listenForPossiblyAccidentalPointers && this._byId.size == 0 && !event.isPrimary) {
return stop(event);
}
// CHECK POINTER ASSUMPTIONS
let pointer: _InternalPointer<UserData> | undefined = this._byId.get(event.pointerId);
if (pointer && pointer._isPresent) return stop(event);
// UPDATE POINTER
pointer = new _InternalPointer(this, event.pointerId, event.pointerType);
this._byId.set(event.pointerId, pointer);
if (this._byId.size == 1) this._first = pointer;
syncEventAndPointer(event, pointer);
resetPresses(pointer);
pointer._verifyValidity();
};
const internalLeave = (event: PointerEvent): void => {
// The enter and leave events aren't bubbling, so ordinarily listeners
// can assume that (event.target == event.currentTarget), but this is
// listening in the capture phase so we have to check that manually.
if (event.target != event.currentTarget) return;
// PREVENT EVENT DEFAULTS: N/A
// EVENT STOP CONDITIONS: N/A
// CHECK POINTER ASSUMPTIONS
let pointer: _InternalPointer<UserData> | undefined = this._byId.get(event.pointerId);
if (!pointer || !pointer._isPresent) return stop(event);
if (pointer._isDown) {
this.dispatchPointerCancelEvent(event.pointerId);
pointer = this._byId.get(event.pointerId);
if (!pointer || !pointer._isPresent) return stop(event);
}
// UPDATE POINTER
syncEventAndPointer(event, pointer);
resetPresses(pointer);
pointer._isInTarget = false;
pointer._isPresent = false;
pointer._verifyValidity();
this._byId.delete(event.pointerId);
};
const internalMove = (event: PointerEvent): void => {
// PREVENT EVENT DEFAULTS
if (this.preventMiddleButtonScrolling &&
event.button == _ButtonIndex.middle &&
(event.buttons & _ButtonBitmask.middle) != 0)
{
// The middle button has been pressed, and could start the scrolling mode
// on some platforms, but that should be prevented.
event.preventDefault();
}
// EVENT STOP CONDITIONS
if (stopEventsAfterTargetIsRemovedFromLayout && !elementIsInLayout(this._target)) {
if (this._byId.has(event.pointerId)) {
this._dispatchPointerLeaveEvent(event.pointerId);
}
return stop(event);
}
if (!this.preventContextMenu &&
event.button == _ButtonIndex.secondary &&
(event.buttons & _ButtonBitmask.secondary) == 0)
{
// The secondary button has been released, and will trigger a contextmenu event.
// Macs do not dispatch a button release event before a contextmenu event.
// For consistency, stop button release events on other platforms too.
return stop(event);
}
// CHECK POINTER ASSUMPTIONS
let pointer: _InternalPointer<UserData> | undefined = this._byId.get(event.pointerId);
const pointerIsDown = (): boolean => (pointer?._isDown ?? false) || (pointer?._gesture?.deferringEvents ?? false);
const pointerPressingButtons = (): number => (pointer?._gesture?.deferringEvents ?? false)
? (pointer?._gesture?.pressingButtons ?? _ButtonBitmask.none)
: (pointer?._pressingButtons ?? _ButtonBitmask.none);
let changedButtonIndex: _ButtonIndex = listenForTheseButtonIndices.has(event.button)
? event.button
: _ButtonIndex.none;
if (!listenForMultipleButtonsDown &&
pointer &&
pointerIsDown() &&
changedButtonIndex != pointer._startedWithButton)
{
changedButtonIndex = _ButtonIndex.none;
}
let pressingButtons: number = pointerPressingButtons();
let addedButton: _ButtonIndex = _ButtonIndex.none;
let removedButton: _ButtonIndex = _ButtonIndex.none;
if (changedButtonIndex != _ButtonIndex.none) {
const changedButtonBitmask: number | undefined = _bitmaskFromButton.get(_buttonFromIndex.get(changedButtonIndex)!);
if (changedButtonBitmask == undefined) throw new Error("EasyPointers: Missing bitmask for button index: " + changedButtonIndex);
const pressingChangedButton: boolean = (event.buttons & changedButtonBitmask) != 0;
if (pressingChangedButton) {
if ((pressingButtons & changedButtonBitmask) != 0) {
this.dispatchPointerCancelEvent(event.pointerId);
pointer = this._byId.get(event.pointerId);
pressingButtons = pointerPressingButtons();
}
addedButton = changedButtonIndex;
pressingButtons = (pressingButtons | changedButtonBitmask);
}
if (!pressingChangedButton && (pressingButtons & changedButtonBitmask) != 0) {
removedButton = changedButtonIndex;
pressingButtons = (pressingButtons & (~changedButtonBitmask));
}
}
const pressingAnyMissingButtons: boolean = (pressingButtons & (~event.buttons)) != 0;
if (pressingAnyMissingButtons) {
this.dispatchPointerCancelEvent(event.pointerId);
pointer = this._byId.get(event.pointerId);
pressingButtons = pointerPressingButtons();
addedButton = _ButtonIndex.none;
removedButton = _ButtonIndex.none;
}
if (addedButton != _ButtonIndex.none && !pointerIsDown()) {
if (this._dispatchPointerDownEvent(event, addedButton).defaultPrevented) {
// Make sure the browser knows the app wanted to prevent the default behavior.
event.preventDefault();
}
return stop(event);
}
if (removedButton != _ButtonIndex.none && pointerIsDown() && pressingButtons == _ButtonBitmask.none) {
if (this._dispatchPointerUpEvent(event, removedButton).defaultPrevented) {
// Make sure the browser knows the app wanted to prevent the default behavior.
event.preventDefault();
}
return stop(event);
}
if (!pointer || !pointer._isPresent) {
if (addedButton != _ButtonIndex.none ||
removedButton != _ButtonIndex.none ||
pressingButtons != _ButtonBitmask.none)
{
throw new Error("EasyPointers: Cannot add or remove buttons on a missing pointer.");
}
this._dispatchPointerEnterEvent(event);
pointer = this._byId.get(event.pointerId);
if (!pointer || !pointer._isPresent) return stop(event);
}
const gesture: _Gesture | null = pointer._gesture;
if (pointerIsDown() && gesture && !gesture.hasMovedFromStart) {
// A rough estimate of the zoom level, to convert from viewport distance to touchscreen distance.
const zoom: number = window.outerWidth / (visualViewport?.width ?? window.innerWidth);
const dx: number = (event.clientX - gesture.startClientX) * zoom;
const dy: number = (event.clientY - gesture.startClientY) * zoom;
const distanceMoved: number = Math.sqrt(dx * dx + dy * dy);
// As a heuristic, assume that if the touch moved past a certain threshold,
// it's probably enough to determine whether it will start scrolling or not.
if (distanceMoved > moveMinDistance) {
gesture.hasMovedFromStart = true;
// If the touch pointer would be canceled in favor of scrolling,
// a pointercancel event will be dispatched, but not until immediately
// after the pointermove event that crossed the threshold. Wait to see
// if the pointercancel event is dispatched.
if (gesture.deferringEvents) {
setTimeout(() => {
if (pointer &&
gesture == pointer._gesture &&
pointer._isPresent &&
pointer == this._byId.get(event.pointerId) &&
gesture.deferringEvents)
{
gesture.stopDeferring();
}
}, 10);
}
}
}
if (gesture && gesture.deferringEvents) {
gesture.deferredEvents.push(event);
gesture.pressingButtons = pressingButtons;
return stop(event);
}
// UPDATE POINTER
syncEventAndPointer(event, pointer);
if (!pointer._isDown) resetPresses(pointer);
pointer._isInTarget = target.contains(document.elementFromPoint(event.clientX, event.clientY));
if (addedButton) pointer._pressedButtons = pressingButtons;
pointer._pressingButtons = pressingButtons;
pointer._justPressedButton = addedButton;
pointer._justReleasedButton = removedButton;
pointer._verifyValidity();
};
const internalDown = (event: PointerEvent): void => {
// PREVENT EVENT DEFAULTS
if (this.preventMiddleButtonScrolling && event.button == _ButtonIndex.middle) event.preventDefault();
// EVENT STOP CONDITIONS
if (stopEventsAfterTargetIsRemovedFromLayout && !elementIsInLayout(this._target)) {
if (this._byId.has(event.pointerId)) {
this._dispatchPointerLeaveEvent(event.pointerId);
}
return stop(event);
}
if (!listenForTheseButtonIndices.has(event.button)) return stop(event);
// On Mac, contextmenu events immediately follow a pointerdown event, and no pointerup
// or pointercancel will follow, but on Windows, a contextmenu event follows a pointerup
// event. We allow the pointerdown event to propagate regardless, in case the application
// needs to toggle preventContextMenu in response to the event:
//const willOpenContextMenu: boolean = (event.button === _ButtonIndex.secondary || (event.ctrlKey && EasyPointers._usingMac));
//if (!this.preventContextMenu && willOpenContextMenu) return stop(event);
// But for consistency, any pointerup event should be replaced with a cancel event, and
// if the pointer is still down when the contextmenu event is dispatched then the pointer
// should be cancelled.
// CHECK POINTER ASSUMPTIONS
let pointer: _InternalPointer<UserData> | undefined = this._byId.get(event.pointerId);
if (pointer && pointer._isDown) {
this.dispatchPointerCancelEvent(event.pointerId);
pointer = this._byId.get(event.pointerId);
}
if (!pointer || !pointer._isPresent) {
if (!listenForMultiplePointers) {
// If only one pointer is allowed at a time, and a new pointer
// is being pressed, and the new pointer is a different type,
// (e.g. because a mouse is present but the user touches the screen)
// then remove the old pointer to make room for the new one.
for (const pointer of this._byId.values()) {
if (pointer.type != event.pointerType) {
this._dispatchPointerLeaveEvent(pointer.id);
}
}
}
this._dispatchPointerEnterEvent(event);
pointer = this._byId.get(event.pointerId);
if (!pointer || !pointer._isPresent) return stop(event);
}
let gesture: _Gesture | null = pointer._gesture;
if (!(gesture?.dispatchingDeferredEvents ?? false)) {
// If the gesture is in the process of dispatching deferred events,
// preserve it, otherwise replace it with a new gesture.
this._target.setPointerCapture(event.pointerId);
gesture = new _Gesture();
pointer._gesture = gesture;
gesture.startClientX = event.clientX;
gesture.startClientY = event.clientY;
if (Number.isFinite(holdStillMinMillis) && holdStillMinMillis > 0) {
setTimeout(() => {
if (pointer &&
gesture &&
gesture == pointer._gesture &&
pointer._isPresent &&
pointer == this._byId.get(event.pointerId) &&
!gesture.wasHeldStill &&
!gesture.hasMovedFromStart)
{
gesture.wasHeldStill = true;
if (gesture.deferringEvents) {
gesture.stopDeferring();
}
}
}, holdStillMinMillis);
}
gesture.deferringEvents = this.deferInitialEvents || (event.pointerType == "touch" && !this.preventTouchGestureScrolling);
if (gesture.deferringEvents) {
gesture.deferredEvents.push(event);
gesture.pressingButtons = event.buttons & listenForTheseButtonsBitmask;
return stop(event);
}
}
// UPDATE POINTER
syncEventAndPointer(event, pointer);
pointer._isDown = true;
pointer._isInTarget = true;
pointer._pressedButtons = event.buttons & listenForTheseButtonsBitmask;
pointer._pressingButtons = event.buttons & listenForTheseButtonsBitmask;
pointer._startedWithButton = event.button;
pointer._justPressedButton = event.button;
pointer._justReleasedButton = _ButtonIndex.none;
pointer._startedWithAltKey = event.altKey;
pointer._startedWithCtrlKey = event.ctrlKey;
pointer._startedWithMetaKey = event.metaKey;
pointer._startedWithShiftKey = event.shiftKey;
pointer._verifyValidity();
// Verify that a pointer that isn't down or in the target has left.
// This condition can be temporarily violated when a pointer is in the
// process of becoming up, because the up event fires before the leave
// event, but this condition should at least be true inside move event
// listeners.
if (!pointer._isDown && !pointer._isInTarget && pointer._isPresent) throw new Error("EasyPointers: A pointer that isn't down or in the target shouldn't be present.");
};
const internalUp = (event: PointerEvent): void => {
// PREVENT EVENT DEFAULTS: N/A
// EVENT STOP CONDITIONS
if (stopEventsAfterTargetIsRemovedFromLayout && !elementIsInLayout(this._target)) {
if (this._byId.has(event.pointerId)) {
this._dispatchPointerLeaveEvent(event.pointerId);
}
return stop(event);
}
if (!this.preventContextMenu && event.button == _ButtonIndex.secondary) {
// Macs do not dispatch a pointerup event before a contextmenu event.
// For consistency, replace pointerup events with cancel events on other
// platforms too.
this.dispatchPointerCancelEvent(event.pointerId);
return stop(event);
}
// CHECK POINTER ASSUMPTIONS
let pointer: _InternalPointer<UserData> | undefined = this._byId.get(event.pointerId);
if (pointer?._gesture?.deferringEvents ?? false) {
pointer!._gesture!.stopDeferring();
pointer = this._byId.get(event.pointerId);
}
if (!pointer || !pointer._isDown) return stop(event);
// UPDATE POINTER
this._target.releasePointerCapture(event.pointerId);
syncEventAndPointer(event, pointer);
pointer._pressingButtons = _ButtonBitmask.none;
pointer._justPressedButton = _ButtonIndex.none;
pointer._justReleasedButton = event.button;
pointer._isDown = false;
pointer._isInTarget = target.contains(document.elementFromPoint(event.clientX, event.clientY));
pointer._verifyValidity();
};
const internalCancel = (event: PointerEvent): void => {
// PREVENT EVENT DEFAULTS: N/A
// EVENT STOP CONDITIONS
// CHECK POINTER ASSUMPTIONS
let pointer: _InternalPointer<UserData> | undefined = this._byId.get(event.pointerId);
if (pointer) pointer._gesture = null;
if (!pointer || !pointer._isDown) return stop(event);
// UPDATE POINTER
this._target.releasePointerCapture(event.pointerId);
syncEventAndPointer(event, pointer);
pointer._pressingButtons = _ButtonBitmask.none;
pointer._justPressedButton = _ButtonIndex.none;
pointer._justReleasedButton = _ButtonIndex.none;
pointer._isDown = false;
pointer._isInTarget = target.contains(document.elementFromPoint(event.clientX, event.clientY));
pointer._verifyValidity();
};
const touchPreventScrolling = (event: TouchEvent): void => {
// The event should be cancelable, but in some cases it might not be,
// in which case this will log an error to the console...
if (this.preventTouchGestureScrolling) {
event.preventDefault();
} else {
for (const pointer of this._byId.values()) {
const gesture: _Gesture | null = pointer._gesture;
if (gesture && !gesture.deferringEvents) {
event.preventDefault();
break;
}
}
}
};
// For presumably historical reasons, adding a mouse event listener
// to an element forces mobile Chrome to treat it as an interactive
// widget for the purposes of deciding which of the elements under
// the finger to interact with. The listener doesn't actually have
// to do anything.
const emptyMousedownForTouchScreen = function(event: MouseEvent): void {};
const selectDragListener = (event: Event): void => {
if (this.preventTextSelection) event.preventDefault();
};
const contextmenu = (event: PointerEvent): void => {
if (this.preventContextMenu) {
event.preventDefault();
} else {
const pointer: _InternalPointer | undefined = this._byId.get(event.pointerId);
if (pointer && pointer._isDown) {
if (pointer._gesture && Number.isFinite(holdStillMinMillis)) {
// If the long-press feature is being used, inhibit the context menu which might otherwise take over the long-press.
event.preventDefault();
} else {
this.dispatchPointerCancelEvent(event.pointerId);
}
}
// TODO: Should I just cancel all down pointers if there's a context menu?
}
}
if (prioritizeTargetOverNeighborsOnTouchScreen) {
target.addEventListener("mousedown", emptyMousedownForTouchScreen as EventListener);
}
target.addEventListener("touchstart", touchPreventScrolling as EventListener, {capture: true, passive: false});
target.addEventListener("touchmove", touchPreventScrolling as EventListener, {capture: true, passive: false});
target.addEventListener("selectstart", selectDragListener as EventListener, {capture: true});
target.addEventListener("selectionchange", selectDragListener as EventListener, {capture: true});
target.addEventListener("dragstart", selectDragListener as EventListener, {capture: true});
target.addEventListener("contextmenu", contextmenu as EventListener, {capture: true});
target.addEventListener("pointerenter", internalEnter as EventListener, {capture: true});
target.addEventListener("pointerleave", internalLeave as EventListener, {capture: true});
target.addEventListener("pointermove", internalMove as EventListener, {capture: true});
target.addEventListener("pointerdown", internalDown as EventListener, {capture: true});
target.addEventListener("pointerup", internalUp as EventListener, {capture: true});
target.addEventListener("pointercancel", internalCancel as EventListener, {capture: true});
this.dispose = () => {
for (const pointer of this._byId.values()) {
this._dispatchPointerLeaveEvent(pointer.id);
}
target.removeEventListener("mousedown", emptyMousedownForTouchScreen as EventListener);
target.removeEventListener("touchstart", touchPreventScrolling as EventListener, {capture: true});
target.removeEventListener("touchmove", touchPreventScrolling as EventListener, {capture: true});
target.removeEventListener("selectstart", selectDragListener as EventListener, {capture: true});
target.removeEventListener("selectionchange", selectDragListener as EventListener, {capture: true});
target.removeEventListener("dragstart", selectDragListener as EventListener, {capture: true});
target.removeEventListener("contextmenu", contextmenu as EventListener, {capture: true});
target.removeEventListener("pointerenter", internalEnter as EventListener, {capture: true});
target.removeEventListener("pointerleave", internalLeave as EventListener, {capture: true});
target.removeEventListener("pointermove", internalMove as EventListener, {capture: true});
target.removeEventListener("pointerdown", internalDown as EventListener, {capture: true});
target.removeEventListener("pointerup", internalUp as EventListener, {capture: true});
target.removeEventListener("pointercancel", internalCancel as EventListener, {capture: true});
EasyPointers._managedTargets.delete(target);
}
}
private _dispatchSyntheticEvent(type: string, modelEvent: PointerEvent, overrides: Partial<PointerEvent>): PointerEvent {
const proxy = new Proxy(modelEvent, {
get(_, key) { return Object.prototype.hasOwnProperty.call(overrides, key) ? (overrides as any)[key] : (modelEvent as any)[key]; },
});
let newEvent: PointerEvent = new PointerEvent(type, proxy);
// TODO: Are there situations when I need to be able to override target? Bubbling enter/leave events?
if (newEvent.bubbles && this._target.contains(modelEvent.target as Node)) {
modelEvent.target!.dispatchEvent(newEvent);
} else {
this._target.dispatchEvent(newEvent);
}
return newEvent;
};
private _dispatchPointerEnterEvent(modelEvent: PointerEvent): PointerEvent {
return this._dispatchSyntheticEvent("pointerenter", modelEvent, {
bubbles: false,
button: _ButtonIndex.none,
buttons: _ButtonBitmask.none,
});
}
private _dispatchPointerLeaveEvent(pointerId: number): PointerEvent | null {
const pointer: _InternalPointer | undefined = this._byId.get(pointerId);
if (!pointer) return null;
return this._dispatchSyntheticEvent("pointerleave", pointer._lastEvent!, {
bubbles: false,
button: _ButtonIndex.none,
buttons: _ButtonBitmask.none,
relatedTarget: null,
});
}
// I'm not dispatching any synthetic move events currently...
private _dispatchPointerDownEvent(modelEvent: PointerEvent, button: _ButtonIndex): PointerEvent {
return this._dispatchSyntheticEvent("pointerdown", modelEvent, {
bubbles: true,
button: button,
buttons: _bitmaskFromButton.get(_buttonFromIndex.get(button)!),
relatedTarget: null,
});
}
private _dispatchPointerUpEvent(modelEvent: PointerEvent, button: _ButtonIndex): PointerEvent {
return this._dispatchSyntheticEvent("pointerup", modelEvent, {
bubbles: true,
button: button,
buttons: _ButtonBitmask.none,
relatedTarget: null,
});
}
public dispatchPointerCancelEvent(pointerId: number): PointerEvent | null {
const pointer: _InternalPointer | undefined = this._byId.get(pointerId);
if (!pointer) return null;
return this._dispatchSyntheticEvent("pointercancel", pointer._lastEvent!, {
bubbles: true,
button: _ButtonIndex.none,
buttons: _ButtonBitmask.none,
relatedTarget: null,
});
}
private _latest: _InternalPointer<UserData>;
public get latest(): Pointer<UserData> { return this._latest; }
private _first: _InternalPointer<UserData>;
public get first(): Pointer<UserData> { return this._first; }
public [Symbol.iterator](): Iterator<Pointer<UserData>> { return this._byId.values(); }
public get count(): number { return this._byId.size; }
public get downCount(): number {
let result: number = 0;
for (const pointer of this._byId.values()) {
if (pointer._isDown) result++;
}
return result;
}
public get anyDown(): boolean {
for (const pointer of this._byId.values()) {
if (pointer.isDown) return true;
}
return false;
}
public get anyPresent(): boolean {
return this._byId.size > 0;
}
public get anyHovering(): boolean {
for (const pointer of this._byId.values()) {
if (pointer.isHovering) return true;
}
return false;
}
public get firstHasJustEntered(): boolean {
return this._byId.size == 1 && this._latest.hasJustEntered;
}
public get firstHasJustBecomeDown(): boolean {
return this.downCount == 1 && this._latest.hasJustBecomeDown;
}
public get lastHasJustLeft(): boolean {
return this._byId.size == 0 && this._latest.hasJustLeft;
}
public get lastHasJustBecomeUp(): boolean {
return this.downCount == 0 && this._latest.hasJustBecomeUp;
}
public get isUsingMouse(): boolean {
for (const pointer of this._byId.values()) {
if (pointer.isMouse) return true;
}
if (this._latest.isMouse) return true;
return false;
}
public get isUsingTouch(): boolean {
for (const pointer of this._byId.values()) {
if (pointer.isTouch) return true;
}
if (this._latest.isTouch) return true;
return false;
}
private _altKey: boolean = false;
public get altKeyIsDown(): boolean { return this._altKey; }
private _ctrlKey: boolean = false;
public get ctrlKeyIsDown(): boolean { return this._ctrlKey; }
private _metaKey: boolean = false;
public get metaKeyIsDown(): boolean { return this._metaKey; }
private _shiftKey: boolean = false;
public get shiftKeyIsDown(): boolean { return this._shiftKey; }
public get ctrlOrMetaKeyIsDown(): boolean { return this._ctrlKey || this._metaKey; }
}
export const enum PointerButton {
none = "none",
primary = "primary",
secondary = "secondary",
middle = "middle",
back = "back",
forward = "forward",
eraser = "eraser",
}
const _buttonSet: Set<`${PointerButton}`> = new Set([
PointerButton.primary,
PointerButton.secondary,
PointerButton.middle,
PointerButton.back,
PointerButton.forward,
PointerButton.eraser,
]);
// https://w3c.github.io/pointerevents/#the-button-property
const enum _ButtonIndex {
none = -1,
primary = 0,
secondary = 2, // Not a typo!
middle = 1,
back = 3,
forward = 4,
eraser = 5,
}
// https://w3c.github.io/pointerevents/#the-buttons-property
const enum _ButtonBitmask {
none = 0,
primary = 1,
secondary = 2,
middle = 4,
back = 8,
forward = 16,
eraser = 32,
}
const _indexFromButton: Map<`${PointerButton}`, _ButtonIndex> = new Map([
[PointerButton.none, _ButtonIndex.none ],
[PointerButton.primary, _ButtonIndex.primary ],
[PointerButton.secondary, _ButtonIndex.secondary],
[PointerButton.middle, _ButtonIndex.middle ],
[PointerButton.back, _ButtonIndex.back ],
[PointerButton.forward, _ButtonIndex.forward ],
[PointerButton.eraser, _ButtonIndex.eraser ],
]);
const _buttonFromIndex: Map<_ButtonIndex, PointerButton> = new Map(Array.from(_indexFromButton, entry => entry.reverse()) as Array<[_ButtonIndex, PointerButton]>);
const _bitmaskFromButton: Map<`${PointerButton}`, _ButtonBitmask> = new Map([
[PointerButton.none, _ButtonBitmask.none ],
[PointerButton.primary, _ButtonBitmask.primary ],
[PointerButton.secondary, _ButtonBitmask.secondary],
[PointerButton.middle, _ButtonBitmask.middle ],
[PointerButton.back, _ButtonBitmask.back ],
[PointerButton.forward, _ButtonBitmask.forward ],
[PointerButton.eraser, _ButtonBitmask.eraser ],
]);
const _buttonFromBitmask: Map<_ButtonBitmask, PointerButton> = new Map(Array.from(_bitmaskFromButton, entry => entry.reverse()) as Array<[_ButtonBitmask, PointerButton]>);
function _buttonSetFromBitmask(buttons: number): Set<PointerButton> {
const result: Set<PointerButton> = new Set();
for (const bitmask of _buttonFromBitmask.keys()) {
if (buttons & bitmask) {
result.add(_buttonFromBitmask.get(bitmask)!);
}
}
return result;
}
export interface Pointer<UserData = unknown> {
readonly id: number;
readonly type: string;
data?: UserData;
get isPresent(): boolean;
get isInTarget(): boolean;
get isDown(): boolean;
get isMouse(): boolean;
get isTouch(): boolean;
get isHovering(): boolean;
get hasJustEntered(): boolean;
get hasJustLeft(): boolean;
get hasJustMoved(): boolean;
get hasJustBecomeDown(): boolean;
get hasJustBecomeUp(): boolean;
get hasJustBeenCanceled(): boolean;
get hasMovedFromStart(): boolean;
get wasHeldStill(): boolean;
get pageX(): number
get pageY(): number
get pointInPage(): Point2d
get viewportX(): number
get viewportY(): number
get pointInViewport(): Point2d
getPointIn(element: HTMLElement | SVGElement, box?: `${ElementBox}`): Point2d
getPointInNormalized(element: HTMLElement, box?: `${ElementBox}`): Point2d
get pressedButtons(): Set<PointerButton>;
get hadPressedPrimaryButton(): boolean;
get hadPressedSecondaryButton(): boolean;
get hadPressedMiddleButton(): boolean;
get hadPressedOnlyPrimaryButton(): boolean;
get hadPressedOnlySecondaryButton(): boolean;
get hadPressedOnlyMiddleButton(): boolean;
hadPressedAny(...buttons: `${PointerButton}`[]): boolean;
hadPressedAll(...buttons: `${PointerButton}`[]): boolean;
hadPressedExactly(...buttons: `${PointerButton}`[]): boolean;
get pressingButtons(): Set<PointerButton>;
get isPressingPrimaryButton(): boolean;
get isPressingSecondaryButton(): boolean;
get isPressingMiddleButton(): boolean;
get isPressingOnlyPrimaryButton(): boolean;
get isPressingOnlySecondaryButton(): boolean;
get isPressingOnlyMiddleButton(): boolean;
isPressingAny(...buttons: `${PointerButton}`[]): boolean;
isPressingAll(...buttons: `${PointerButton}`[]): boolean;
isPressingExactly(...buttons: `${PointerButton}`[]): boolean;
get startedWithButton(): PointerButton;
get startedWithPrimaryButton(): boolean;
get startedWithSecondaryButton(): boolean;
get startedWithMiddleButton(): boolean;
get justPressedButton(): PointerButton;
get hasJustPressedPrimaryButton(): boolean;
get hasJustPressedSecondaryButton(): boolean;
get hasJustPressedMiddleButton(): boolean;
get justReleasedButton(): PointerButton;
get hasJustReleasedPrimaryButton(): boolean;
get hasJustReleasedSecondaryButton(): boolean;
get hasJustReleasedMiddleButton(): boolean;
get startedWithAltKey(): boolean;
get startedWithCtrlKey(): boolean;
get startedWithMetaKey(): boolean;
get startedWithShiftKey(): boolean;
cancel(): void;
}
class _Gesture {
public startClientX: number = 0;
public startClientY: number = 0;
public deferredEvents: PointerEvent[] = [];
public deferringEvents: boolean = true;
public dispatchingDeferredEvents: boolean = false;
public pressingButtons: number = _ButtonBitmask.none;
public hasMovedFromStart: boolean = false;
public wasHeldStill: boolean = false;
public stopDeferring(): void {
this.deferringEvents = false;
this.dispatchingDeferredEvents = true;
for (const event of this.deferredEvents) {
event.target!.dispatchEvent(new PointerEvent(event.type, event));
}
this.dispatchingDeferredEvents = false;
this.deferredEvents.length = 0;
}
}
class _InternalPointer<UserData = unknown> implements Pointer<UserData> {
public _lastEvent: PointerEvent | null = null;
public _gesture: _Gesture | null = null;
constructor(
private readonly _pointers: EasyPointers,
public readonly id: number,
public readonly type: string) {}
public data?: UserData;
public _isPresent: boolean = true;
public get isPresent(): boolean { return this._isPresent; }
public _isInTarget: boolean = true;
public get isInTarget(): boolean { return this._isInTarget && this._isPresent; }
public _isDown: boolean = false;
public get isDown(): boolean { return this._isDown; }
public get isMouse(): boolean { return (this.type == "mouse"); }
public get isTouch(): boolean { return (this.type == "touch"); }
public get isHovering(): boolean {
return (this._isInTarget && !this._isDown && this.type != "touch");
}
public _hasJustEntered: boolean = false;
public get hasJustEntered(): boolean { return this._hasJustEntered; }
public _hasJustLeft: boolean = false;
public get hasJustLeft(): boolean { return this._hasJustLeft; }
public _hasJustMoved: boolean = false;
public get hasJustMoved(): boolean { return this._hasJustMoved; }
public _hasJustBecomeDown: boolean = false;
public get hasJustBecomeDown(): boolean { return this._hasJustBecomeDown; }
public _hasJustBecomeUp: boolean = false;
public get hasJustBecomeUp(): boolean { return this._hasJustBecomeUp; }
public _hasJustBeenCanceled: boolean = false;
public get hasJustBeenCanceled(): boolean { return this._hasJustBeenCanceled; }
public get hasMovedFromStart(): boolean { return this._gesture?.hasMovedFromStart ?? false; }
public get wasHeldStill(): boolean { return this._gesture?.wasHeldStill ?? false; }
public _pressedButtons: number = _ButtonBitmask.none;
public get pressedButtons(): Set<PointerButton> { return _buttonSetFromBitmask(this._pressedButtons); }
public get hadPressedPrimaryButton(): boolean { return (this._pressedButtons & _ButtonBitmask.primary) != 0; }
public get hadPressedSecondaryButton(): boolean { return (this._pressedButtons & _ButtonBitmask.secondary) != 0; }
public get hadPressedMiddleButton(): boolean { return (this._pressedButtons & _ButtonBitmask.middle) != 0; }
public get hadPressedOnlyPrimaryButton(): boolean { return (this._pressedButtons == _ButtonBitmask.primary); }
public get hadPressedOnlySecondaryButton(): boolean { return (this._pressedButtons == _ButtonBitmask.secondary); }
public get hadPressedOnlyMiddleButton(): boolean { return (this._pressedButtons == _ButtonBitmask.middle); }
public hadPressedAny(...buttons: `${PointerButton}`[]): boolean {
for (const button of buttons) {
if (this._pressedButtons & _bitmaskFromButton.get(button)!) return true;
}
return false;
}
public hadPressedAll(...buttons: `${PointerButton}`[]): boolean {
for (const button of buttons) {
if (!(this._pressedButtons & _bitmaskFromButton.get(button)!)) return false;
}
return true;
}
public hadPressedExactly(...buttons: `${PointerButton}`[]): boolean {
let mask: number = 0;
for (const button of buttons) mask |= _bitmaskFromButton.get(button)!;
return (this._pressedButtons == mask);
}
public _pressingButtons: number = _ButtonBitmask.none;
public get pressingButtons(): Set<PointerButton> { return _buttonSetFromBitmask(this._pressingButtons); }
public get isPressingPrimaryButton(): boolean { return (this._pressingButtons & _ButtonBitmask.primary) != 0; }
public get isPressingSecondaryButton(): boolean { return (this._pressingButtons & _ButtonBitmask.secondary) != 0; }
public get isPressingMiddleButton(): boolean { return (this._pressingButtons & _ButtonBitmask.middle) != 0; }
public get isPressingOnlyPrimaryButton(): boolean { return (this._pressingButtons == _ButtonBitmask.primary); }
public get isPressingOnlySecondaryButton(): boolean { return (this._pressingButtons == _ButtonBitmask.secondary); }
public get isPressingOnlyMiddleButton(): boolean { return (this._pressingButtons == _ButtonBitmask.middle); }
public isPressingAny(...buttons: `${PointerButton}`[]): boolean {
for (const button of buttons) {
if (this._pressingButtons & _bitmaskFromButton.get(button)!) return true;
}
return false;
}
public isPressingAll(...buttons: `${PointerButton}`[]): boolean {
for (const button of buttons) {
if (!(this._pressingButtons & _bitmaskFromButton.get(button)!)) return false;
}
return true;
}
public isPressingExactly(...buttons: `${PointerButton}`[]): boolean {
let mask: number = 0;
for (const button of buttons) mask |= _bitmaskFromButton.get(button)!;
return (this._pressingButtons == mask);
}
public _startedWithButton: _ButtonIndex = _ButtonIndex.none;
public get startedWithButton(): PointerButton { return _buttonFromIndex.get(this._startedWithButton)!; }
public get startedWithPrimaryButton(): boolean { return this._startedWithButton == _ButtonIndex.primary; }
public get startedWithSecondaryButton(): boolean { return this._startedWithButton == _ButtonIndex.secondary; }