world.go

package turtle

import (
	"image"
	"image/color"
	"image/draw"
	"image/png"
	"os"
)

// A world to draw on.
type World struct {
	Image         *image.RGBA
	Width, Height int

	DrawLineCh chan Line
	doneLineCh chan bool
	closeCh    chan bool
}

// Create a new World of the requested size.
func NewWorld(width, height int) *World {
	return NewWorldWithColor(width, height, SoftBlack)
}

// Create a new World of the requested size and background color.
func NewWorldWithColor(width, height int, c color.Color) *World {
	m := image.NewRGBA(image.Rect(0, 0, width, height))
	draw.Draw(m, m.Bounds(), &image.Uniform{c}, image.Point{0, 0}, draw.Src)
	return NewWorldWithImage(m)
}

// Create a new World attached to an image.
func NewWorldWithImage(m *image.RGBA) *World {
	drawCh := make(chan Line)
	doneCh := make(chan bool)
	closeCh := make(chan bool)
	w := &World{
		Image:      m,
		Width:      m.Bounds().Max.X,
		Height:     m.Bounds().Max.Y,
		DrawLineCh: drawCh,
		doneLineCh: doneCh,
		closeCh:    closeCh,
	}
	// Start listening on w.DrawLineCh for lines to draw.
	go w.listen()
	return w
}

// Reset the current image, keep the current size, default background color.
func (w *World) ResetImage() {
	w.ResetImageWithSizeColor(w.Width, w.Height, SoftBlack)
}

// Reset the current image, changing the size, default background color.
func (w *World) ResetImageWithSize(width, height int) {
	w.ResetImageWithSizeColor(width, height, SoftBlack)
}

// Reset the current image, changing the size and background color.
func (w *World) ResetImageWithSizeColor(width, height int, c color.Color) {
	m := image.NewRGBA(image.Rect(0, 0, width, height))
	draw.Draw(m, m.Bounds(), &image.Uniform{c}, image.Point{0, 0}, draw.Src)
	w.ResetImageWithImage(m)
}

// Reset the current image to the provided one.
func (w *World) ResetImageWithImage(m *image.RGBA) {
	w.Image = m
	w.Width = m.Bounds().Max.X
	w.Height = m.Bounds().Max.Y
}

// Save output
func (w *World) SaveImage(filePath string) error {
	f, err := os.Create(filePath)
	if err != nil {
		return err
	}
	defer f.Close()
	err = png.Encode(f, w.Image)
	return err
}

// Close the world channels, and stop the listen goroutine.
func (w *World) Close() {
	w.closeCh <- true
}

// listen for draw commands on drawLineCh.
func (w *World) listen() {
	for {
		select {

		// draw the received line and wait for it to be drawn
		// the pen inside is a reference, so if you change
		// color/size before it is drawn it will change
		// MAYBE not using a reference is better and clearer
		case line := <-w.DrawLineCh:
			w.drawLine(line)
			w.doneLineCh <- true

		// close the channels and exit the func
		case <-w.closeCh:
			close(w.closeCh)
			close(w.DrawLineCh)
			return
		}
	}
}

// Draw a line on the image.
func (w *World) drawLine(l Line) {
	x0 := int(l.X0)
	y0 := int(l.Y0)
	x1 := int(l.X1)
	y1 := int(l.Y1)

	// line is vertical
	if x0 == x1 {
		if y0 > y1 {
			y1, y0 = y0, y1
		}
		for i := y0; i <= y1; i++ {
			w.setPoint(x0, i, l.p)
		}
		return
	}

	// line is horizontal
	if y0 == y1 {
		if x0 > x1 {
			x1, x0 = x0, x1
		}
		for i := x0; i <= x1; i++ {
			w.setPoint(i, y0, l.p)
		}
		return
	}

	// line is diagonal, draw it with Bresenham algo
	dx := intAbs(x1 - x0)
	dy := -intAbs(y1 - y0)
	var sx, sy int
	if x0 < x1 {
		sx = 1
	} else {
		sx = -1
	}
	if y0 < y1 {
		sy = 1
	} else {
		sy = -1
	}
	err := dx + dy

	var e2 int
	for {
		w.setPoint(x0, y0, l.p)
		if x0 == x1 && y0 == y1 {
			return
		}
		e2 = 2 * err
		if e2 >= dy {
			err += dy
			x0 += sx
		}
		if e2 <= dx {
			err += dx
			y0 += sy
		}
	}
}

// Draw a point on the image.
func (w *World) setPoint(x, y int, p *Pen) {
	// the y in the reference frame of the image
	yr := w.Height - y - 1

	// always draw at least one pixel
	if p.Size <= 1 {
		w.Image.Set(x, yr, p.Color)
		return
	}

	half := p.Size / 2
	before := half
	// if the size is even, remove a pixel from the left/bottom
	// in the cartesian coord
	if p.Size%2 == 0 {
		before = half - 1
	}
	// fill the square
	for i := -before; i <= half; i++ {
		for ii := -before; ii <= half; ii++ {
			// yr-ii because before/half are in cartesian coord
			// so we move to image coord by flipping the y axis
			w.Image.Set(x+i, yr-ii, p.Color)
		}
	}
}