Merge branch 'button-decorator'

Author: magicmonkey

decorators/border.go

@@ -0,0 +1,46 @@
+package decorators
+
+import (
+	"image"
+	"image/color"
+)
+
+type Border struct {
+	width  int
+	colour color.Color
+}
+
+func NewBorder(width int, colour color.Color) *Border {
+	b := &Border{width: width, colour: colour}
+	return b
+}
+
+func (b *Border) Apply(img image.Image) image.Image {
+	newimg := img.(*image.RGBA)
+	// TODO base the 96 on the image bounds
+	for i := 0; i < b.width; i++ {
+		rect(i, i, 96-i, 96-i, newimg, b.colour)
+	}
+	return newimg
+}
+
+// Utility functions from https://stackoverflow.com/questions/28992396/draw-a-rectangle-in-golang
+
+func hLine(x1, y, x2 int, img *image.RGBA, colour color.Color) {
+	for ; x1 <= x2; x1++ {
+		img.Set(x1, y, colour)
+	}
+}
+
+func vLine(x, y1, y2 int, img *image.RGBA, colour color.Color) {
+	for ; y1 <= y2; y1++ {
+		img.Set(x, y1, colour)
+	}
+}
+
+func rect(x1, y1, x2, y2 int, img *image.RGBA, colour color.Color) {
+	hLine(x1, y1, x2, img, colour)
+	hLine(x1, y2, x2, img, colour)
+	vLine(x1, y1, y2, img, colour)
+	vLine(x2, y1, y2, img, colour)
+}

examples/client.go

@@ -7,6 +7,7 @@ import (
 	streamdeck "github.com/magicmonkey/go-streamdeck"
 	"github.com/magicmonkey/go-streamdeck/actionhandlers"
 	"github.com/magicmonkey/go-streamdeck/buttons"
+	"github.com/magicmonkey/go-streamdeck/decorators"
 )
 
 func main() {
@@ -40,6 +41,16 @@ func main() {
 	multiActionButton.SetActionHandler(thisActionHandler)
 	sd.AddButton(27, multiActionButton)
 
+	decoratedButton := buttons.NewTextButton("ABC")
+	sd.AddButton(19, decoratedButton)
+
+	time.Sleep(2 * time.Second)
+	decorator1 := decorators.NewBorder(10, color.RGBA{0, 255, 0, 255})
+	sd.SetDecorator(19, decorator1)
+	time.Sleep(2 * time.Second)
+	decorator2 := decorators.NewBorder(5, color.RGBA{255, 0, 0, 255})
+	sd.SetDecorator(19, decorator2)
+
 	time.Sleep(2 * time.Second)
 
 	myButton.SetText("Bye!")

examples/client2.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"image/color"
+	"strconv"
+	"sync"
+
+	streamdeck "github.com/magicmonkey/go-streamdeck"
+	"github.com/magicmonkey/go-streamdeck/actionhandlers"
+	"github.com/magicmonkey/go-streamdeck/buttons"
+	"github.com/magicmonkey/go-streamdeck/decorators"
+)
+
+func main() {
+	var current int
+
+	sd, err := streamdeck.New()
+	if err != nil {
+		panic(err)
+	}
+
+	btns := make([]*buttons.TextButton, 32)
+	for i := 0; i < 32; i++ {
+		btns[i] = buttons.NewTextButton(strconv.Itoa(i))
+		sd.AddButton(i, btns[i])
+	}
+
+	greenBorder := decorators.NewBorder(10, color.RGBA{0, 255, 0, 255})
+
+	redBorder := decorators.NewBorder(5, color.RGBA{255, 0, 0, 255})
+	for i := 0; i < 32; i++ {
+		sd.SetDecorator(i, redBorder)
+	}
+
+	for i := 0; i < 32; i++ {
+		h := actionhandlers.NewCustomAction(func(btn streamdeck.Button) {
+			sd.SetDecorator(current, redBorder)
+			sd.SetDecorator(btn.GetButtonIndex(), greenBorder)
+			current = btn.GetButtonIndex()
+		})
+		btns[i].SetActionHandler(h)
+	}
+
+	var wg sync.WaitGroup
+	wg.Add(1)
+	wg.Wait()
+
+}

streamdeck.go

@@ -21,10 +21,15 @@ type Button interface {
 	ButtonDisplay
 }
 
+type ButtonDecorator interface {
+	Apply(image.Image) image.Image
+}
+
 // StreamDeck is the main struct to represent a StreamDeck device, and internally contains the reference to a `Device`
 type StreamDeck struct {
-	dev     *Device
-	buttons map[int]Button
+	dev        *Device
+	buttons    map[int]Button
+	decorators map[int]ButtonDecorator
 }
 
 // New will return a new instance of a `StreamDeck`, and is the main entry point for the higher-level interface.  It will return an error if there is no StreamDeck plugged in.
@@ -36,6 +41,7 @@ func New() (*StreamDeck, error) {
 	}
 	sd.dev = d
 	sd.buttons = make(map[int]Button)
+	sd.decorators = make(map[int]ButtonDecorator)
 	sd.dev.ButtonPress(sd.pressHandler)
 	return sd, nil
 }
@@ -48,6 +54,15 @@ func (sd *StreamDeck) AddButton(btnIndex int, b Button) {
 	sd.updateButton(b)
 }
 
+func (sd *StreamDeck) SetDecorator(btnIndex int, d ButtonDecorator) {
+	sd.decorators[btnIndex] = d
+	// If there's a button there, update it
+	btn, ok := sd.buttons[btnIndex]
+	if ok {
+		sd.updateButton(btn)
+	}
+}
+
 // ButtonUpdateHandler allows a user of this library to signal when something external has changed, such that this button should be update
 func (sd *StreamDeck) ButtonUpdateHandler(b Button) {
 	sd.buttons[b.GetButtonIndex()] = b
@@ -66,6 +81,10 @@ func (sd *StreamDeck) pressHandler(btnIndex int, d *Device, err error) {
 
 func (sd *StreamDeck) updateButton(b Button) error {
 	img := b.GetImageForButton()
+	decorator, ok := sd.decorators[b.GetButtonIndex()]
+	if ok {
+		img = decorator.Apply(img)
+	}
 	e := sd.dev.WriteRawImageToButton(b.GetButtonIndex(), img)
 	return e
 }