README.md

Voronoi

A Vornoi Diagram Generator on Unity using C# Job System (DOTS).

Unity Version: 2022.3.44f1

Performance

Diagram Size	Performance in ms
5x5	0.4 - 0.5
25x25	98 - 100
50x50	1725 - 1800

Usage

• Create a serialized VoronoiPlane object in your MonoBehaviour script and Generate it.

    [field: SerializeField] public VoronoiPlane VoronoiPlane { get; private set; }

    private void Update()
    {
        // Generate Voronoi Diagram on Space Key Press
        if (Input.GetKeyDown(KeyCode.Space))
        {
            VoronoiPlane.Generate(transform);
        }
    }
    
    private void OnDestroy()
    {
        // Dispose the Voronoi Diagram
        VoronoiPlane.Dispose();
    }

• The VoronoiPlane.Generate() method takes a Transform object as an argument that determines the position and rotation of the diagram, you can also alternatively use VoronoiDiagram.Generate(Vector3 origin, Vector3 forward, Vector3 up) where origin will be used to position the diagram while forward and up are used to rotate the diagram.
• You can also use the VoronoiPlane object to get the generated Voronoi Diagram Cells.

    // Get the Voronoi Diagram data
    Cell[] cells = VoronoiPlane.Cells;

• Each cell contains the center point of each cell as Cell.Center and an array of segments and vertices for each cell arranged in a clockwise order as Cell.Segments and Cell.Vertices.

    Cell[] cells = VoronoiPlane.Cells;
    
    for (int i = 0; i < cells.Length; i++)
    {
        Cell cell = cells[i];
        
        // Center point of a Voronoi cell
        Vector3 center = cell.Center;
        
        // Segments of a single Voronoi cell arranged in a clockwise manner
        Segment[] segments = cell.Segments;
        
        // Vertices of a single Voronoi cell arranged in a clockwise manner
        float3[] vertices = cell.Vertices;
    }

• Each segment contains the start and end points of the segment as Segment.Start and Segment.End ordered clockwise.
• You can also visualize the Voronoi Diagram by either adding a Drawer instance in your scene and enabling VoronoiPlane.drawGizmos in the inspector or by calling VoronoiPlane.Draw() in OnDrawGizmos.

---

⚠️Caution⚠️

As you go higher up in diagram size significantly (> 2500 cells | 50x50) you'll start to get a specific exception Next segment not unique more and more frequently which happens due to floating point precision. In cases where you need a significantly large diagram perhaps consider more than one adjacent diagrams or consider refactoring the source code to use double and double3 instead of float and float3.

---