## WARNING

**The library is KNOWN TO HAVE BUGS!!!** Unfortunately, currently I don't have resources to investigate them thoroughly enough and in timely fashion. In case somebody is interested in taking ownership of the library, I'm open to ceding it. That said, the issues totally haunt me and occasionally I stubbornly try to come back to them and pick the fight up again. In particular:

- #3 was confirmed to be
**an omission in the original paper/algorithm**. As far as I understand, it surfaces when one of the polygons used has self-overlapping edges (e.g. when an edge (0,0)-(1,1) is used twice in the same polygon). I believe it should be possible to fix, but it requires thorough analysis of the algorithm and good testing. One attempt I made at a fix which seemed OK initially was later found to break the library even more and thus I reverted it. - #8 was reported recently and I haven't yet had time to even start investigating it.

## About

Library polyclip-go is a pure Go, MIT-licensed implementation of an [algorithm for Boolean operations on 2D polygons] fmartin (invented by F. MartÃnez, A.J. Rueda, F.R. Feito) -- that is, for calculation of polygon intersection, union, difference and xor.

The original paper describes the algorithm as performing in time *O((n+k) log n)*, where *n* is number of all edges of all polygons in operation, and *k* is number of intersections of all polygon edges.

## Example

Simplest Go program using polyclip-go for calculating intersection of a square and triangle:

```
// example.go
package main
import (
"fmt"
"github.com/akavel/polyclip-go" // or: bitbucket.org/...
)
func main() {
subject := polyclip.Polygon{{{1, 1}, {1, 2}, {2, 2}, {2, 1}}} // small square
clipping := polyclip.Polygon{{{0, 0}, {0, 3}, {3, 0}}} // overlapping triangle
result := subject.Construct(polyclip.INTERSECTION, clipping)
// will print triangle: [[{1 1} {1 2} {2 1}]]
fmt.Println(result)
}
```

To compile and run the program above, execute the usual sequence of commands:

```
go get github.com/akavel/polyclip-go # or: bitbucket.org/...
go build example.go
./example # Windows: example.exe
```

For full package documentation, run locally `godoc github.com/akavel/polyclip-go`

, or visit online documentation for polyclip-go.

## See also

- Online docs for polyclip-go.
- Microsite about the original algorithm, from its authors (with PDF, and public-domain code in C++).
- The as3polyclip library -- a MIT-licensed ActionScript3 library implementing this same algorithm (it actually served as a base for polyclip-go). The page also contains some thoughts with regards to speed of the algorithm.