triangolatte
2D triangulation library. Allows translating lines and polygons (both based on points) to the language of GPUs.
Features normal and miter joint line triangulation. Handles polygons using ear clipping algorithm with hole elimination included.
For reference: triangulates 99.76% of 75 thousand buildings in Cracow under 3.43s on average programmer notebook (single threaded).
Table of contents
Installation
Nothing surprising
go get github.com/tchayen/triangolatte
Usage
Basic example
vertices := []Point{{10, 20}, {30, 40}, {50, 60}}
t, err = triangolatte.Polygon(vertices)
Examples
In /examples you can find:
- buildings – full-blown WebGL previewer of buildings triangulated in city example
- city – triangulation of whole city downloaded from Open Street Map
- gpx – GPX format parsing and triangulation of its data
- wireframe – desktop OpenGL wireframe previewer for triangulated shapes
You will find instructions for running the code there.
Features
API
Polygon(points []Point, holes [][]Point) ([]float64, error)
Takes array of points and produces array of triangle coordinates.
Based on the following paper and inspired by EarCut.
JoinHoles(points [][]Point) ([]Point, error)
Removes holes, joining them with the rest of the polygon. Provides preprocessing for Polygon. First element of the points array is the outer polygon, the rest of them are considered as holes to be removed.
Line(joint Joint, points []Point, width int) ([]float64, error)
Takes array of points and triangulates them to resemble a line of given width. Returns array of two-coordinate CCW triangles one after another.
Types
To select method of joining line segments.
type Joint int
const (
// No joint correction.
Normal Joint = 0
// Producing miter joints, i.e. extending the lines until they meet at some point.
Miter Joint = 1
)
For calculations using points.
type Point struct {
X, Y float64
}
A wrapper for Point used in cyclic list.
type Element struct {
Prev, Next *Element
Point Point
}
Helpers
You can have a look at helpers.go file. It stores triangolatte's helper functions used mostly by tests and examples. They are not exported because I don't want to commit to supporting them in the future, but they might turn out useful for you.
Tests
Code is (more or less) covered in tests. You can run them like this:
go test -v
You can also run benchmarks for selected functions (refer to the *_test.go files for availability). For example:
go test -run NONE -bench IsInsideTriangle
Benchmarks
NOTE: This section contains work in progress. Numbers below are better reference point than nothing, but still far from perfect.
Polygon() on shape with 10 vertices takes 754ns on average.
Triangulation of 75 thousand buildings runs for around 3.43s.
Using average programmer's notebook. Expect speed up on faster CPUs or while splitting execution into separate threads.
Flame Graphs
CPU time % usage snaphost using Flame Graphs:
Want to learn what is it or maybe you are willing to generate one yourself? Check FlameGraphs document in this repository.
Future plans
Optimizations
NOTE: this library is developed mostly with map data triangulation in mind and it will be its main performance target.
- explore possibilities for optimizations in
JoinHoles(...) - maybe allow reusing point array for massive allocation reduction
Content
- provide more examples (e.g. desktop OpenGL usage, mobile app, live rendering pipeline, other unusual use cases...)
- add benchmarks with comparison to libraries in other languages
WebAssembly
One of the core plans for this library's development is creating, as soon as it becomes possible, some kind of WebAssembly module for use in JS.
Contributing
You are welcome to create an issue or pull request if you've got an idea what to do. It is usually a good idea to visit Gitter and discuss your thoughts.
Don't have one, but still want to contribute? Get in touch with us and we can brainstorm some ideas.
License
MIT License – refer to the LICENSE file.
6.3k Jan 8, 2023
13 Oct 12, 2022
2.6k Dec 26, 2022
19 Nov 10, 2022
20 Oct 19, 2022
23 Sep 27, 2022
19 Nov 18, 2022
918 Dec 31, 2022
706 Dec 20, 2022
610 Dec 28, 2022
136 Jan 8, 2023
169 Dec 18, 2022
14 Jan 8, 2023
2k Dec 29, 2022
49 Nov 29, 2022
15.6k Jan 7, 2023
226 Jan 1, 2023
2.7k Jan 4, 2023
0 Jul 25, 2022