io/router: deliver scroll events only to the foremost scroll handler

Signed-off-by: Gordon Klaus <gordon.klaus@gmail.com>

io/pointer/doc.go

@@ -23,6 +23,8 @@ Leave, or Scroll):
 		Types: pointer.Press | pointer.Move | pointer.Release,
 	}.Add(ops)
 
+Scroll events are only delivered to the foremost scroll handler.
+
 Cancel events are always delivered.
 
 Areas

io/router/pointer.go

@@ -267,6 +267,11 @@ func (q *pointerQueue) deliverEvent(p *pointerInfo, events *handlerEvents, e poi
 		e.Position = h.transform.Invert().Transform(e.Position)
 
 		addPointerEvent(events, k, e, h.types)
+
+		// Only deliver scroll events to the foremost handler.
+		if e.Type == pointer.Scroll && e.Type&h.types != 0 {
+			return
+		}
 	}
 }
 

io/router/pointer_test.go

@@ -125,6 +125,49 @@ func TestPointerTypes(t *testing.T) {
 	assertEventSequence(t, r.Events(handler), pointer.Cancel, pointer.Press, pointer.Release)
 }
 
+func TestPointerScroll(t *testing.T) {
+	handler1 := new(int)
+	handler2 := new(int)
+	var ops op.Ops
+
+	pointer.Rect(image.Rect(0, 0, 100, 100)).Add(&ops)
+	pointer.InputOp{Tag: handler1, Types: pointer.Scroll}.Add(&ops)
+
+	pointer.Rect(image.Rect(0, 0, 100, 50)).Add(&ops)
+	pointer.InputOp{Tag: handler2, Types: pointer.Scroll}.Add(&ops)
+
+	var r Router
+	r.Frame(&ops)
+	r.Add(
+		// Hit handler 2.
+		pointer.Event{
+			Type: pointer.Scroll,
+			Position: f32.Point{
+				X: 50,
+				Y: 25,
+			},
+		},
+		// Hit handler 1.
+		pointer.Event{
+			Type: pointer.Scroll,
+			Position: f32.Point{
+				X: 50,
+				Y: 75,
+			},
+		},
+		// Hit no handlers.
+		pointer.Event{
+			Type: pointer.Scroll,
+			Position: f32.Point{
+				X: 50,
+				Y: 125,
+			},
+		},
+	)
+	assertEventSequence(t, r.Events(handler1), pointer.Cancel, pointer.Scroll)
+	assertEventSequence(t, r.Events(handler2), pointer.Cancel, pointer.Scroll)
+}
+
 func TestPointerEnterLeave(t *testing.T) {
 	handler1 := new(int)
 	handler2 := new(int)