4 releases (2 breaking)

0.2.0 Feb 28, 2022
0.1.1 Oct 31, 2021
0.1.0 Jun 6, 2021
0.0.1 Jan 9, 2021

#116 in Visualization

Download history 33/week @ 2024-08-03 38/week @ 2024-08-10 26/week @ 2024-08-17 27/week @ 2024-08-24 29/week @ 2024-08-31 26/week @ 2024-09-07 31/week @ 2024-09-14 78/week @ 2024-09-21 44/week @ 2024-09-28 11/week @ 2024-10-05 12/week @ 2024-10-12 23/week @ 2024-10-19 21/week @ 2024-10-26 24/week @ 2024-11-02 7/week @ 2024-11-09 11/week @ 2024-11-16

67 downloads per month
Used in 4 crates (3 directly)

MIT license

120KB
1.5K SLoC

Voronoice

Crate API Build

A nice and fast way to construct 2D Voronoi diagrams written in Rust.

Voronoice builds Voronoi diagrams by first obtaining its Delaunay triangulation, through the really fast delaunator crate and then extracting its dual Voronoi diagram.

Example

use voronoice::*;

// voronoi sites
let sites = vec![
    Point { x: 0.0, y: 0.0 }, Point { x: 1.0, y: 0.0 }, Point { x: 0.0, y: 1.0 }
];

// builds a voronoi diagram from the set of sites above, bounded by a square of size 4
let my_voronoi = VoronoiBuilder::default()
    .set_sites(sites)
    .set_bounding_box(BoundingBox::new_centered_square(4.0))
    .set_lloyd_relaxation_iterations(5)
    .build()
    .unwrap();

// inspect cells through iterators
my_voronoi.iter_cells().for_each(|cell| {
    println!("Vertices of cell: {:?}", cell.vertices().collect::<Vec<&Point>>())
});

// or probe cells individually
let my_cell = my_voronoi.cell(1);
println!("Second cell has site {:?}, voronoi vertices {:?} and delaunay triangles {:?}",
    my_cell.site_position(),
    my_cell.vertices().collect::<Vec<&Point>>(),
    my_cell.triangles().collect::<Vec<usize>>());

// or, for graphical applications, that benefit from index buffers
// you can access the raw, indexed data
let all_voronoi_cell_vertices = my_voronoi.vertices();
let indexed_voronoi_cells = my_voronoi.cells();
println!("The first vertex position for the first voronoi cell is at {:?}",
    all_voronoi_cell_vertices[indexed_voronoi_cells[0][0]]);

Documentation

On docs.rs.

Performance

Here are some generation times on a 3.5GHz Core i7 from 2012.

Number of points Time
1,000 150 µs
10,000 1.5 ms
100,000 18 ms
1,000,000 270 ms
5,000,000 1.6 s
10,000,000 3.5 s

A comparison benchmark with other Rust Voronoi diagram generating libraries can be found here.

Examples

svg

cargo run --example svg -- -s10 -l2 -z0.8 -o example.svg --render-labels false

Generates a SVG image to visualize the Voronoi-Delaunay graph. Provide --help to see other options.

Example of SVG Voronoi

image

cargo run --release --example image -- examples/assets/mona_noice_small.jpg 300

Generates a color averaged image by overlaying a Voronoi diagram

Original image Image after voronoi cell averaging

Others

Dependencies

~575KB