Skip to content

nothke/csDelaunayUnity

Repository files navigation

A GC alloc free version of csDelaunay by PouletFrit optimised for runtime generation

This version has breaking changes between the original, so it is not necesarily a "fork". Since this is used for a personal project where only constructing voronoi diagrams and retrieving clipped edges was needed, all other features are not tested nor guaranteed to be GC alloc free (like LloydRelaxation), and some methods may be removed or commented out.

How to use alloc free

To make sure the code runs alloc-free you must initialize element pools with capacities suited to your [maximum] number of sites. This process is not required, but every time the lists and queues get extended, you will have a GC alloc, which is recommended to avoid.

In the current version, Voronoi.Redo() is only guarnteed to be alloc free with a fixed number of sites

1. Analyse capacities

You can find out the required capacities by creating a test voronoi diagram and rebuilding it many times. At the end call voronoi.DebugCapacities(), for example: To make the code run alloc-free you must initialize element pools with capacities suited to your [maximum] number of sites. You can find out the required capacities by creating a test voronoi diagram and rebuild it many times, at the end call voronoi.DebugCapacities() like so:

void AnalyseCapacities()
{
    voronoi = new Voronoi(points, new Rectf(0, 0, 2, 2));

    for (int i = 0; i < 1000; i++)
    {
        CreateRandomPoints(points);
        voronoi.Redo(points, new Rectf(0, 0, 2, 2));
    }

    Debug.Log(voronoi.DebugCapacities());
}

You might get a result like this:

Sites: 50, Halfedges: 217, Edges: 138, EdgesPerSite: 20, Vertices: 153

(also, alternatively, see Test/CapacityTest examples, you can use the TestRunner to run and view the results)

2. Init pools with capacities

These are your maximum capacities. Now, take the last 3 numbers (and add a with a few more as a margin, just in case) and call InitPools before you create your Voronoi:

Voronoi.InitPools(225, 150, 25, 160);
voronoi = new Voronoi(points, new Rectf(0, 0, 2, 2));

3. Profit

Now, next time you call:

voronoi.Redo(points, new Rectf(0,0,2,2));

You should have no GC allocs at all!

About

GC free (non alloc) voronoi diagram for Unity

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages