joejulian/gio-patched
1
0
Fork 0
forked from joejulian/gio
Code Pull Requests 1 Activity

io/pointer,io/router: replace AreaOp with clip.Op

Browse Source 
Pointer hit areas and paint clip areas are separate concepts, but
similar enough to warrant merging. This change replaces pointer hit
areas with clip areas, so Gio is left with just one area concept (in
package op/clip).

The reason for separating the concepts in the original Gio release was
because of my being unsure general path/stroke hit areas would ever be
implemented, let alone efficient.

This change represents a change of mind, in the sense that it's better
to have an incomplete API than two separate area concepts.

Leave the deprecated pointer.Rect, pointer.Ellipse for temporary
backwards compatibility.

This is an API change. Most existing programs should continue to build
with this change, but may have to adjust to having all clip.Ops participate
in InputOp hit areas.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
This commit is contained in:
Elias Naur
2021-10-25 11:31:04 +02:00
parent 28fc08a508
commit 29cea1db49
12 changed files with 127 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/ops/ops.go
+11 -12
View File
@@ -29,6 +29,8 @@ type Ops struct {
type OpType byte
type Shape byte
// Start at a high number for easier debugging.
const firstOpIndex = 200
@@ -44,8 +46,6 @@ const (
TypePaint
TypeColor
TypeLinearGradient
TypeArea
TypePopArea
TypePass
TypePopPass
TypePointerInput
@@ -91,15 +91,21 @@ type StackKind uint8
type ClipOp struct {
Bounds image.Rectangle
Outline bool
Shape Shape
}
const (
ClipStack StackKind = iota
AreaStack
TransStack
PassStack
)
const (
Path Shape = iota
Ellipse
Rect
)
const (
TypeMacroLen = 1 + 4 + 4
TypeCallLen = 1 + 4 + 4
@@ -112,8 +118,6 @@ const (
TypePaintLen = 1
TypeColorLen = 1 + 4
TypeLinearGradientLen = 1 + 8*2 + 4*2
TypeAreaLen = 1 + 1 + 4*4
TypePopAreaLen = 1
TypePassLen = 1
TypePopPassLen = 1
TypePointerInputLen = 1 + 1 + 1*2 + 2*4 + 2*4
@@ -125,7 +129,7 @@ const (
TypeSaveLen = 1 + 4
TypeLoadLen = 1 + 4
TypeAuxLen = 1
TypeClipLen = 1 + 4*4 + 1
TypeClipLen = 1 + 4*4 + 1 + 1
TypePopClipLen = 1
TypeProfileLen = 1
TypeCursorLen = 1 + 1
@@ -151,6 +155,7 @@ func (op *ClipOp) Decode(data []byte) {
*op = ClipOp{
Bounds: r,
Outline: data[17] == 1,
Shape: Shape(data[18]),
}
}
@@ -332,8 +337,6 @@ func (t OpType) Size() int {
TypePaintLen,
TypeColorLen,
TypeLinearGradientLen,
TypeAreaLen,
TypePopAreaLen,
TypePassLen,
TypePopPassLen,
TypePointerInputLen,
@@ -389,10 +392,6 @@ func (t OpType) String() string {
return "Color"
case TypeLinearGradient:
return "LinearGradient"
case TypeArea:
return "Area"
case TypePopArea:
return "PopArea"
case TypePass:
return "Pass"
case TypePopPass:
io/pointer/doc.go
+16 -12
View File
@@ -25,19 +25,23 @@ Leave, or Scroll):
Cancel events are always delivered.
Areas
Hit areas
The area operations are used for specifying the area where
subsequent InputOp are active.
Clip operations from package op/clip are used for specifying
hit areas where subsequent InputOps are active.
For example, to set up a rectangular hit area:
For example, to set up a handler with a rectangular hit area:
r := image.Rectangle{...}
pointer.Rect(r).Add(ops)
area := clip.Rect(r).Push(ops)
pointer.InputOp{Tag: h}.Add(ops)
area.Pop()
Note that areas compound: the effective area of multiple area
operations is the intersection of the areas.
Note that hit areas behave similar to painting: the effective area of a stack
of multiple area operations is the intersection of the areas.
BUG: Clip operations other than clip.Rect and clip.Ellipse are approximated
with their bounding boxes.
Matching events
@@ -49,11 +53,11 @@ For example:
ops := new(op.Ops)
var h1, h2 *Handler
area := pointer.Rect(...).Push(ops)
area := clip.Rect(...).Push(ops)
pointer.InputOp{Tag: h1}.Add(Ops)
area.Pop()
area := pointer.Rect(...).Push(ops)
area := clip.Rect(...).Push(ops)
pointer.InputOp{Tag: h2}.Add(ops)
area.Pop()
@@ -66,9 +70,9 @@ parent areas all contain the event is considered.
Then, every handler attached to the area is matched with the event.
If all attached handlers are marked pass-through, the matching repeats with the
next foremost (sibling) area. Otherwise the matching repeats with the parent
area.
If all attached handlers are marked pass-through or if no handlers are
attached, the matching repeats with the next foremost (sibling) area. Otherwise
the matching repeats with the parent area.
In the example above, all events will go to h2 because it and h1 are siblings
and none are pass-through.
io/pointer/pointer.go
+20 -54
View File
@@ -14,6 +14,7 @@ import (
"gioui.org/io/event"
"gioui.org/io/key"
"gioui.org/op"
"gioui.org/op/clip"
)
// Event is a pointer event.
@@ -42,20 +43,6 @@ type Event struct {
Modifiers key.Modifiers
}
// AreaOp pushes the current hit area to the stack and updates it to the
// intersection of the current hit area and the transformed area.
type AreaOp struct {
kind areaKind
rect image.Rectangle
}
// AreaStack represents an AreaOp on the stack of areas.
type AreaStack struct {
ops *ops.Ops
id ops.StackID
macroID int
}
// PassOp sets the pass-through mode. InputOps added while the pass-through
// mode is set don't block events to siblings.
type PassOp struct {
@@ -107,9 +94,6 @@ type Buttons uint8
// CursorName is the name of a cursor.
type CursorName string
// Must match app/internal/input.areaKind
type areaKind uint8
const (
// CursorDefault is the default cursor.
CursorDefault CursorName = ""
@@ -178,50 +162,32 @@ const (
ButtonTertiary
)
const (
areaRect areaKind = iota
areaEllipse
)
// Rect constructs a rectangular hit area.
func Rect(size image.Rectangle) AreaOp {
return AreaOp{
kind: areaRect,
rect: size,
}
//
// Deprecated: use clip.Rect instead.
func Rect(size image.Rectangle) clip.Op {
return clip.Rect(size).Op()
}
// Ellipse constructs an ellipsoid hit area.
func Ellipse(size image.Rectangle) AreaOp {
return AreaOp{
kind: areaEllipse,
rect: size,
//
// Deprecated: use clip.Ellipse instead.
func Ellipse(size image.Rectangle) clip.Ellipse {
return clip.Ellipse(frect(size))
}
// frect converts a rectangle to a f32.Rectangle.
func frect(r image.Rectangle) f32.Rectangle {
return f32.Rectangle{
Min: fpt(r.Min), Max: fpt(r.Max),
}
}
// Push the current area to the stack and intersects the current area with the
// area represented by o.
func (a AreaOp) Push(o *op.Ops) AreaStack {
id, macroID := ops.PushOp(&o.Internal, ops.AreaStack)
a.add(o, true)
return AreaStack{ops: &o.Internal, id: id, macroID: macroID}
}
func (a AreaOp) add(o *op.Ops, push bool) {
data := ops.Write(&o.Internal, ops.TypeAreaLen)
data[0] = byte(ops.TypeArea)
data[1] = byte(a.kind)
bo := binary.LittleEndian
bo.PutUint32(data[2:], uint32(a.rect.Min.X))
bo.PutUint32(data[6:], uint32(a.rect.Min.Y))
bo.PutUint32(data[10:], uint32(a.rect.Max.X))
bo.PutUint32(data[14:], uint32(a.rect.Max.Y))
}
func (o AreaStack) Pop() {
ops.PopOp(o.ops, ops.AreaStack, o.id, o.macroID)
data := ops.Write(o.ops, ops.TypePopAreaLen)
data[0] = byte(ops.TypePopArea)
// fpt converts an point to a f32.Point.
func fpt(p image.Point) f32.Point {
return f32.Point{
X: float32(p.X), Y: float32(p.Y),
}
}
// Push the current pass mode to the pass stack and set the pass mode.
io/pointer/pointer_test.go
-14
View File
@@ -4,8 +4,6 @@ package pointer
import (
"testing"
"gioui.org/op"
)
func TestTypeString(t *testing.T) {
@@ -33,15 +31,3 @@ func TestTypeString(t *testing.T) {
})
}
}
func TestTransformChecks(t *testing.T) {
defer func() {
if err := recover(); err == nil {
t.Error("cross-macro Pop didn't panic")
}
}()
var ops op.Ops
area := AreaOp{}.Push(&ops)
op.Record(&ops)
area.Pop()
}
io/router/pointer.go
+21 -22
View File
@@ -107,13 +107,18 @@ func (c *pointerCollector) load(id int) {
c.state = collectState{t: c.states[id]}
}
func (c *pointerCollector) area(op areaOp) {
func (c *pointerCollector) clip(op ops.ClipOp) {
area := -1
if i := c.state.nodePlusOne - 1; i != -1 {
n := c.q.hitTree[i]
area = n.area
}
c.q.areas = append(c.q.areas, areaNode{trans: c.state.t, next: area, area: op})
kind := areaRect
if op.Shape == ops.Ellipse {
kind = areaEllipse
}
areaOp := areaOp{kind: kind, rect: frect(op.Bounds)}
c.q.areas = append(c.q.areas, areaNode{trans: c.state.t, next: area, area: areaOp})
c.nodeStack = append(c.nodeStack, c.state.nodePlusOne-1)
c.q.hitTree = append(c.q.hitTree, hitNode{
next: c.state.nodePlusOne - 1,
@@ -123,6 +128,20 @@ func (c *pointerCollector) area(op areaOp) {
c.state.nodePlusOne = len(c.q.hitTree) - 1 + 1
}
// frect converts a rectangle to a f32.Rectangle.
func frect(r image.Rectangle) f32.Rectangle {
return f32.Rectangle{
Min: fpt(r.Min), Max: fpt(r.Max),
}
}
// fpt converts an point to a f32.Point.
func fpt(p image.Point) f32.Point {
return f32.Point{
X: float32(p.X), Y: float32(p.Y),
}
}
func (c *pointerCollector) popArea() {
n := len(c.nodeStack)
c.state.nodePlusOne = c.nodeStack[n-1] + 1
@@ -477,26 +496,6 @@ func opDecodeFloat32(d []byte) float32 {
return float32(int32(binary.LittleEndian.Uint32(d)))
}
func (op *areaOp) Decode(d []byte) {
if ops.OpType(d[0]) != ops.TypeArea {
panic("invalid op")
}
rect := f32.Rectangle{
Min: f32.Point{
X: opDecodeFloat32(d[2:]),
Y: opDecodeFloat32(d[6:]),
},
Max: f32.Point{
X: opDecodeFloat32(d[10:]),
Y: opDecodeFloat32(d[14:]),
},
}
*op = areaOp{
kind: areaKind(d[1]),
rect: rect,
}
}
func (op *areaOp) Hit(pos f32.Point) bool {
pos = pos.Sub(op.rect.Min)
size := op.rect.Size()
io/router/pointer_test.go
+28
View File
@@ -13,6 +13,7 @@ import (
"gioui.org/io/key"
"gioui.org/io/pointer"
"gioui.org/op"
"gioui.org/op/clip"
)
func TestPointerWakeup(t *testing.T) {
@@ -733,6 +734,33 @@ func TestAreaPassthrough(t *testing.T) {
assertEventSequence(t, r.Events(h), pointer.Cancel, pointer.Press)
}
func TestEllipse(t *testing.T) {
var ops op.Ops
h := new(int)
cl := clip.Ellipse(f32.Rect(0, 0, 100, 100)).Push(&ops)
pointer.InputOp{Tag: h, Types: pointer.Press}.Add(&ops)
cl.Pop()
var r Router
r.Frame(&ops)
r.Queue(
// Outside ellipse.
pointer.Event{
Position: f32.Pt(10, 10),
Type: pointer.Press,
},
pointer.Event{
Type: pointer.Release,
},
// Inside ellipse.
pointer.Event{
Position: f32.Pt(50, 50),
Type: pointer.Press,
},
)
assertEventSequence(t, r.Events(h), pointer.Cancel, pointer.Press)
}
// addPointerHandler adds a pointer.InputOp for the tag in a
// rectangular area.
func addPointerHandler(ops *op.Ops, tag event.Tag, area image.Rectangle) {
io/router/router.go
+4 -4
View File
@@ -162,11 +162,11 @@ func (q *Router) collect() {
pc.load(id)
// Pointer ops.
case ops.TypeArea:
var op areaOp
case ops.TypeClip:
var op ops.ClipOp
op.Decode(encOp.Data)
pc.area(op)
case ops.TypePopArea:
pc.clip(op)
case ops.TypePopClip:
pc.popArea()
case ops.TypePass:
pc.pass()
op/clip/clip.go
+3 -2
View File
@@ -47,7 +47,6 @@ func (p Op) Push(o *op.Ops) Stack {
func (p Op) add(o *op.Ops) {
path := p.path
outline := p.outline
bo := binary.LittleEndian
if path.hasSegments {
@@ -77,9 +76,10 @@ func (p Op) add(o *op.Ops) {
bo.PutUint32(data[5:], uint32(bounds.Min.Y))
bo.PutUint32(data[9:], uint32(bounds.Max.X))
bo.PutUint32(data[13:], uint32(bounds.Max.Y))
if outline {
if p.outline {
data[17] = byte(1)
}
data[18] = byte(path.shape)
}
func (s Stack) Pop() {
@@ -96,6 +96,7 @@ type PathSpec struct {
// hasSegments tracks whether there are any segments in the path.
hasSegments bool
bounds image.Rectangle
shape ops.Shape
hash uint64
}
op/clip/doc.go
+3 -3
View File
@@ -1,10 +1,10 @@
// SPDX-License-Identifier: Unlicense OR MIT
/*
Package clip provides operations for clipping paint operations.
Drawing outside the current clip area is ignored.
Package clip provides operations for defining areas that applies to operations
such as paints and pointer handlers.
The current clip is initially the infinite set. Pushing and Op sets the clip
The current clip is initially the infinite set. Pushing an Op sets the clip
to the intersection of the current clip and pushed clip area. Popping the
area restores the clip to its state before pushing.
op/clip/shapes.go
+15 -12
View File
@@ -7,6 +7,7 @@ import (
"math"
"gioui.org/f32"
"gioui.org/internal/ops"
"gioui.org/op"
)
@@ -18,6 +19,7 @@ func (r Rect) Op() Op {
return Op{
outline: true,
path: PathSpec{
shape: ops.Rect,
bounds: image.Rectangle(r),
},
}
@@ -132,18 +134,16 @@ func (c Circle) Path(ops *op.Ops) PathSpec {
Min: f32.Pt(c.Center.X-c.Radius, c.Center.Y-c.Radius),
Max: f32.Pt(c.Center.X+c.Radius, c.Center.Y+c.Radius),
}
return Ellipse{b}.Path(ops)
return Ellipse(b).path(ops)
}
// Ellipse represents the largest axis-aligned ellipse that
// is contained in its bounds.
type Ellipse struct {
Bounds f32.Rectangle
}
type Ellipse f32.Rectangle
// Op returns the op for the filled ellipse.
func (e Ellipse) Op(ops *op.Ops) Op {
return Outline{Path: e.Path(ops)}.Op()
return Outline{Path: e.path(ops)}.Op()
}
// Push the filled ellipse clip op on the clip stack.
@@ -151,17 +151,18 @@ func (e Ellipse) Push(ops *op.Ops) Stack {
return e.Op(ops).Push(ops)
}
// Path constructs a path for the ellipse.
func (e Ellipse) Path(ops *op.Ops) PathSpec {
// path constructs a path for the ellipse.
func (e Ellipse) path(o *op.Ops) PathSpec {
var p Path
p.Begin(ops)
p.Begin(o)
center := e.Bounds.Max.Add(e.Bounds.Min).Mul(.5)
diam := e.Bounds.Dx()
bounds := f32.Rectangle(e)
center := bounds.Max.Add(bounds.Min).Mul(.5)
diam := bounds.Dx()
r := diam * .5
// We'll model the ellipse as a circle scaled in the Y
// direction.
scale := e.Bounds.Dy() / diam
scale := bounds.Dy() / diam
// https://pomax.github.io/bezierinfo/#circles_cubic.
const q = 4 * (math.Sqrt2 - 1) / 3
@@ -190,7 +191,9 @@ func (e Ellipse) Path(ops *op.Ops) PathSpec {
f32.Point{X: center.X - curve, Y: center.Y - r*scale},
top,
)
return p.End()
ellipse := p.End()
ellipse.shape = ops.Ellipse
return ellipse
}
func fPt(p image.Point) f32.Point {
op/paint/doc.go
+3 -2
View File
@@ -3,8 +3,9 @@
/*
Package paint provides drawing operations for 2D graphics.
The PaintOp operation fills the current clip with the current brush,
taking the current transformation into account.
The PaintOp operation fills the current clip with the current brush, taking the
current transformation into account. Drawing outside the current clip area is
ignored.
The current brush is set by either a ColorOp for a constant color, or
ImageOp for an image, or LinearGradientOp for gradients.
widget/list.go
+3 -3
View File
@@ -92,19 +92,19 @@ func (s *Scrollbar) Layout(gtx layout.Context, axis layout.Axis, viewportStart,
}
// AddTrack configures the track click listener for the scrollbar to use
// the most recently added pointer.AreaOp.
// the current clip area.
func (s *Scrollbar) AddTrack(ops *op.Ops) {
s.track.Add(ops)
}
// AddIndicator configures the indicator click listener for the scrollbar to use
// the most recently added pointer.AreaOp.
// the current clip area.
func (s *Scrollbar) AddIndicator(ops *op.Ops) {
s.indicator.Add(ops)
}
// AddDrag configures the drag listener for the scrollbar to use
// the most recently added pointer.AreaOp.
// the current clip area.
func (s *Scrollbar) AddDrag(ops *op.Ops) {
s.drag.Add(ops)
}