Skip to content

Commit 45742b7

Browse files
arnoblarnobl
committed
fix(interaction): unexpected touches now cancel touch interactions
1 parent acfa447 commit 45742b7

6 files changed

Lines changed: 88 additions & 47 deletions

File tree

‎src/impl/fsm/ConcurrentFSM.ts‎

Lines changed: 48 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,25 @@ import {FSMImpl} from "./FSMImpl";
2020
* A concurrent FSM: an FSM that contains multiple FSMs that run concurrently.
2121
*/
2222
export class ConcurrentFSM<F extends FSM> extends FSMImpl {
23-
private readonly conccurFSMs: ReadonlyArray<F>;
23+
/**
24+
* The main fsms
25+
*/
26+
private readonly _conccurFSMs: ReadonlyArray<F>;
27+
28+
/**
29+
* Secondary fsms. These fsms are not considered to determine whether the interaction has started
30+
*/
31+
private readonly _secondaryFSMs: ReadonlyArray<F>;
2432

2533
private readonly totalReinit: boolean;
2634

27-
public constructor(fsms: ReadonlyArray<F>, totalReinit: boolean = false) {
35+
/**
36+
* Creates the FSM
37+
* @param fsms - The main concurrent FSMs
38+
* @param secondaries - The secondary FSMs. Not considered in some steps.
39+
* @param totalReinit - Defines whether a cancellation of one of the fsms, reinits all the fsms.
40+
*/
41+
public constructor(fsms: ReadonlyArray<F>, secondaries: ReadonlyArray<F> = [], totalReinit: boolean = false) {
2842
super();
2943

3044
this.totalReinit = totalReinit;
@@ -45,21 +59,36 @@ export class ConcurrentFSM<F extends FSM> extends FSMImpl {
4559
this.onCancelling();
4660
}
4761
};
48-
this.conccurFSMs = [...fsms];
62+
this._conccurFSMs = [...fsms];
63+
this._secondaryFSMs = [...secondaries];
4964
this.conccurFSMs.forEach(fsm => {
5065
fsm.addHandler(handler);
5166
});
5267
}
5368

5469
/**
55-
* @returns All the FSMs in an copy of the original array.
70+
* @returns All the main and secondary FSMs
71+
*/
72+
public getAllConccurFSMs(): ReadonlyArray<F> {
73+
return [...this._conccurFSMs, ...this._secondaryFSMs];
74+
}
75+
76+
/**
77+
* @returns The main FSMs
5678
*/
57-
public getConccurFSMs(): ReadonlyArray<F> {
58-
return [...this.conccurFSMs];
79+
public get conccurFSMs(): ReadonlyArray<F> {
80+
return [...this._conccurFSMs];
81+
}
82+
83+
/**
84+
* @returns The secondary FSMs
85+
*/
86+
public get secondaryFSMs(): ReadonlyArray<FSM> {
87+
return [...this._secondaryFSMs];
5988
}
6089

6190
public override process(event: Event): boolean {
62-
return this.conccurFSMs.some(conccurFSM => conccurFSM.process(event));
91+
return this.getAllConccurFSMs().some(conccurFSM => conccurFSM.process(event));
6392
}
6493

6594
public override get started(): boolean {
@@ -72,20 +101,29 @@ export class ConcurrentFSM<F extends FSM> extends FSMImpl {
72101
this.conccurFSMs.forEach(fsm => {
73102
fsm.log = log;
74103
});
104+
this.secondaryFSMs.forEach(fsm => {
105+
fsm.log = log;
106+
});
75107
}
76108

77109
public override uninstall(): void {
78110
super.uninstall();
79111
this.conccurFSMs.forEach(fsm => {
80112
fsm.uninstall();
81113
});
114+
this.secondaryFSMs.forEach(fsm => {
115+
fsm.uninstall();
116+
});
82117
}
83118

84119
public override fullReinit(): void {
85120
if (this.totalReinit) {
86121
this.conccurFSMs.forEach(f => {
87122
f.fullReinit();
88123
});
124+
this.secondaryFSMs.forEach(f => {
125+
f.fullReinit();
126+
});
89127
}
90128
super.fullReinit();
91129
}
@@ -95,6 +133,9 @@ export class ConcurrentFSM<F extends FSM> extends FSMImpl {
95133
this.conccurFSMs.forEach(f => {
96134
f.reinit();
97135
});
136+
this.secondaryFSMs.forEach(f => {
137+
f.reinit();
138+
});
98139
}
99140
super.reinit();
100141
}

‎src/impl/interaction/ConcurrentInteraction.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export abstract class ConcurrentInteraction<D extends InteractionData, DImpl ext
3737
*/
3838
protected constructor(fsm: F, data: DImpl) {
3939
super(fsm, data);
40-
this.subscriptions = this.fsm.getConccurFSMs()
40+
this.subscriptions = this.fsm.getAllConccurFSMs()
4141
.map(conc => conc.currentStateObservable
4242
.subscribe(current => {
4343
this.updateEventsRegistered(current[1], current[0]);
@@ -61,7 +61,7 @@ export abstract class ConcurrentInteraction<D extends InteractionData, DImpl ext
6161
}
6262

6363
public override getCurrentAcceptedEvents(_state?: OutputState): ReadonlyArray<EventType> {
64-
return this.fsm.getConccurFSMs().flatMap(concFSM => [...this.getEventTypesOf(concFSM.currentState)]);
64+
return this.fsm.getAllConccurFSMs().flatMap(concFSM => [...this.getEventTypesOf(concFSM.currentState)]);
6565
}
6666

6767
public override uninstall(): void {

‎src/impl/interaction/library/MultiTouch.ts‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,13 @@ class MultiTouchFSM extends ConcurrentFSM<TouchDnDFSM> {
2828
* Creates the FSM.
2929
*/
3030
public constructor(nbTouch: number, totalReinit: boolean) {
31-
super([...Array(nbTouch).keys()].map(_ => new TouchDnDFSM(false, false)), totalReinit);
31+
super([...Array(nbTouch).keys()].map(_ => new TouchDnDFSM(false, false)),
32+
totalReinit ? [new TouchDnDFSM(false, false)] : [], totalReinit);
3233
}
3334

3435
public override buildFSM(dataHandler: TouchDnDFSMHandler): void {
3536
super.buildFSM(dataHandler);
36-
this.getConccurFSMs().forEach(fsm => {
37+
this.getAllConccurFSMs().forEach(fsm => {
3738
fsm.buildFSM(dataHandler);
3839
});
3940
}
@@ -48,17 +49,17 @@ class MultiTouchFSM extends ConcurrentFSM<TouchDnDFSM> {
4849

4950
// eslint-disable-next-line @typescript-eslint/prefer-for-of
5051
for (let i = 0; i < event.changedTouches.length; i++) {
52+
// console.log(event.changedTouches[i].identifier);
5153
// Finding an FSM that is currently running with this ID
52-
const touches: Array<TouchDnDFSM> = this.getConccurFSMs()
54+
const touches: Array<TouchDnDFSM> = this.conccurFSMs
5355
.filter(fsm => fsm.getTouchId() === event.changedTouches[i].identifier);
54-
5556
if (touches.length > 0) {
5657
processed = true;
5758
res = touches[0].process(event) || res;
5859
} else {
5960
// If no FSM found, two meanings:
6061
// 1/ the touch event is unexpected since all the FSMs are running, so cancelling
61-
const remainingFSMs = this.getConccurFSMs().filter(fsm => fsm.getTouchId() === undefined);
62+
const remainingFSMs = this.conccurFSMs.filter(fsm => fsm.getTouchId() === undefined);
6263
if (remainingFSMs.length === 0) {
6364
this.onCancelling();
6465
res = false;
@@ -114,7 +115,7 @@ export class MultiTouch extends ConcurrentInteraction<MultiTouchData, MultiTouch
114115
},
115116

116117
"reinitData": (): void => {
117-
const currentIDs = this.fsm.getConccurFSMs()
118+
const currentIDs = this.fsm.conccurFSMs
118119
.filter(fsm => fsm.started)
119120
.map(fsm => fsm.getTouchId());
120121

‎test/binder/SwipeBinder.test.ts‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -192,26 +192,26 @@ test("swipe starts but another touch occurs (move) cancels the interaction", ()
192192
expect(newHandler.fsmStops).not.toHaveBeenCalled();
193193
});
194194

195-
// test("swipe starts but another touch occurs cancels the interaction", () => {
196-
// binding = bindings.swipeBinder(true, 400, 200, 1, 10)
197-
// .toProduce(() => new StubCmd(true))
198-
// .on(c1)
199-
// .bind();
200-
//
201-
// const newHandler = mock<FSMHandler>();
202-
// binding.interaction.fsm.addHandler(newHandler);
203-
//
204-
// robot(c1)
205-
// .touchstart({}, [{"identifier": 3, "screenX": 50, "screenY": 20, "clientX": 100, "clientY": 200}], 5000)
206-
// .touchmove({}, [{"identifier": 3, "screenX": 160, "screenY": 30, "clientX": 160, "clientY": 201}], 5500)
207-
// .touchstart({}, [{"identifier": 2, "screenX": 260, "screenY": 30, "clientX": 160, "clientY": 201}], 5550)
208-
// .touchmove({}, [{"identifier": 3, "screenX": 250, "screenY": 30, "clientX": 500, "clientY": 210}], 6000)
209-
// .touchend({}, [{"identifier": 3, "screenX": 450, "screenY": 30, "clientX": 500, "clientY": 210}], 6000);
210-
//
211-
// expect(ctx.commands).toHaveLength(0);
212-
// expect(newHandler.fsmCancels).toHaveBeenCalledTimes(1);
213-
// expect(newHandler.fsmStops).not.toHaveBeenCalled();
214-
// });
195+
test("swipe starts but another touch occurs cancels the interaction", () => {
196+
binding = bindings.swipeBinder(true, 400, 200, 1, 10)
197+
.toProduce(() => new StubCmd(true))
198+
.on(c1)
199+
.bind();
200+
201+
const newHandler = mock<FSMHandler>();
202+
binding.interaction.fsm.addHandler(newHandler);
203+
204+
robot(c1)
205+
.touchstart({}, [{"identifier": 3, "screenX": 50, "screenY": 20, "clientX": 100, "clientY": 200}], 5000)
206+
.touchmove({}, [{"identifier": 3, "screenX": 160, "screenY": 30, "clientX": 160, "clientY": 201}], 5500)
207+
.touchstart({}, [{"identifier": 2, "screenX": 260, "screenY": 30, "clientX": 160, "clientY": 201}], 5550)
208+
.touchmove({}, [{"identifier": 3, "screenX": 250, "screenY": 30, "clientX": 500, "clientY": 210}], 6000)
209+
.touchend({}, [{"identifier": 3, "screenX": 450, "screenY": 30, "clientX": 500, "clientY": 210}], 6000);
210+
211+
expect(ctx.commands).toHaveLength(0);
212+
expect(newHandler.fsmCancels).toHaveBeenCalledTimes(1);
213+
expect(newHandler.fsmStops).not.toHaveBeenCalled();
214+
});
215215

216216
test("one touch and then swipes does not swipe", () => {
217217
binding = bindings.swipeBinder(true, 400, 200, 2, 10)

‎test/fsm/ConcurrentFSM.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ beforeEach(() => {
9393
});
9494

9595
test("nb FSMs OK", () => {
96-
expect(fsm.getConccurFSMs()).toHaveLength(2);
96+
expect(fsm.conccurFSMs).toHaveLength(2);
9797
});
9898

9999
test("log OK", () => {

‎test/interaction/library/MultiTouch.test.ts‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ afterEach(() => {
3838

3939
test("touch1", () => {
4040
interaction.processEvent(createTouchEvent("touchstart", 3, canvas, 11, 23, 11, 23));
41-
expect(interaction.fsm.getConccurFSMs()
41+
expect(interaction.fsm.conccurFSMs
4242
.filter(fsm => fsm.started)).toHaveLength(1);
4343
expect(interaction.isRunning()).toBeFalsy();
4444
expect(handler.fsmStarts).not.toHaveBeenCalled();
@@ -57,7 +57,7 @@ test("touch1 data", () => {
5757
test("touch2", () => {
5858
interaction.processEvent(createTouchEvent("touchstart", 1, canvas, 11, 23, 11, 23));
5959
interaction.processEvent(createTouchEvent("touchstart", 2, canvas, 11, 23, 11, 23));
60-
expect(interaction.fsm.getConccurFSMs()
60+
expect(interaction.fsm.conccurFSMs
6161
.filter(fsm => fsm.started)).toHaveLength(2);
6262
expect(interaction.isRunning()).toBeFalsy();
6363
expect(handler.fsmStarts).not.toHaveBeenCalled();
@@ -80,7 +80,7 @@ test("touch3", () => {
8080
interaction.processEvent(createTouchEvent("touchstart", 1, canvas, 11, 23, 11, 23));
8181
interaction.processEvent(createTouchEvent("touchstart", 3, canvas, 21, 13, 21, 13));
8282
interaction.processEvent(createTouchEvent("touchstart", 2, canvas, 210, 130, 210, 130));
83-
expect(interaction.fsm.getConccurFSMs()
83+
expect(interaction.fsm.conccurFSMs
8484
.filter(fsm => fsm.started)).toHaveLength(3);
8585
expect(interaction.isRunning()).toBeTruthy();
8686
expect(handler.fsmStarts).toHaveBeenCalledTimes(1);
@@ -106,8 +106,7 @@ test("touch3 with one error event", () => {
106106
interaction.processEvent(createTouchEvent("touchstart", 1, canvas, 11, 23, 11, 23));
107107
interaction.processEvent(createTouchEvent("touchstart", 3, canvas, 21, 13, 21, 13));
108108
interaction.processEvent(createTouchEvent("touchstart", 3, canvas, 210, 130, 210, 130));
109-
expect(interaction.fsm.getConccurFSMs()
110-
.filter(fsm => fsm.started)).toHaveLength(2);
109+
expect(interaction.fsm.conccurFSMs.filter(fsm => fsm.started)).toHaveLength(2);
111110
expect(interaction.isRunning()).toBeFalsy();
112111
expect(handler.fsmStarts).not.toHaveBeenCalled();
113112
expect(handler.fsmUpdates).not.toHaveBeenCalled();
@@ -218,9 +217,9 @@ test("touch starts", () => {
218217
.touchstart({}, [{"identifier": 1, "screenX": 50, "screenY": 20, "clientX": 100, "clientY": 200}], 5000)
219218
.touchstart({}, [{"identifier": 2, "screenX": 50, "screenY": 20, "clientX": 100, "clientY": 200}], 5000);
220219

221-
expect(interaction.fsm.getConccurFSMs()[0].started).toBeTruthy();
222-
expect(interaction.fsm.getConccurFSMs()[1].started).toBeTruthy();
223-
expect(interaction.fsm.getConccurFSMs()[2].started).toBeTruthy();
220+
expect(interaction.fsm.conccurFSMs[0].started).toBeTruthy();
221+
expect(interaction.fsm.conccurFSMs[1].started).toBeTruthy();
222+
expect(interaction.fsm.conccurFSMs[2].started).toBeTruthy();
224223
expect(interaction.fsm.started).toBeTruthy();
225224
});
226225

@@ -238,9 +237,9 @@ test("touchs not all started", () => {
238237
robot(canvas)
239238
.touchstart({}, [{"identifier": 3, "screenX": 50, "screenY": 20, "clientX": 100, "clientY": 200}], 5000);
240239

241-
expect(interaction.fsm.getConccurFSMs()[0].started).toBeTruthy();
242-
expect(interaction.fsm.getConccurFSMs()[1].started).toBeFalsy();
243-
expect(interaction.fsm.getConccurFSMs()[2].started).toBeFalsy();
240+
expect(interaction.fsm.conccurFSMs[0].started).toBeTruthy();
241+
expect(interaction.fsm.conccurFSMs[1].started).toBeFalsy();
242+
expect(interaction.fsm.conccurFSMs[2].started).toBeFalsy();
244243
expect(interaction.fsm.started).toBeFalsy();
245244
});
246245

0 commit comments

Comments
 (0)