boostvoronoi

Crates.ioboostvoronoi
lib.rsboostvoronoi
version0.11.1
sourcesrc
created_at2021-01-22 12:36:25.151067
updated_at2023-12-08 18:54:50.411768
descriptionBoost voronoi ported to 100% rust
homepage
repositoryhttps://codeberg.org/eadf/boostvoronoi_rs
max_upload_size
id345300
size2,154,182
eadf (eadf)

documentation

README

Rusty voronoi

crates.io Documentation status-badge dependency status license

Segmented Voronoi for Rust

Boost 1.76.0 polygon::voronoi ported to 100% rust. This implementation of Fortune's algorithm works for line segments as well as points, making it useful for calculating centerlines (like the title image above).

Code still in development, there are still bugs. However, all the remaining bugs I've noticed are also present in C++ boost voronoi.

Gui example:

cargo run --example fltk_gui
  • Mouse click to place new points.
  • Press and hold 'L' + mouse click to add a single line.
  • Press and hold 'S' + mouse click to add strings of lines.
  • Use mouse wheel to zoom.
  • Mouse click and drag to pan.

API example:

use boostvoronoi::prelude::*;

type I = i32; // this is the integer input type
type F = f64; // this is the float output type

fn main() -> Result<(), BvError> {
    // Only unique Points will be used. Points should not
    // intersect lines.
    let p = vec!([9_i32, 10]);
    // Lines may only intersect at the endpoints.
    let s = vec!([10_i32, 11, 12, 33]);
    let diagram = Builder::<I, F>::default()
        // You will have to keep track of the input geometry. it
        // will be referenced as input geometry indices in the
        // output.
        // `with_vertices()` accepts iterators of anything that
        // implements `Into<boostvoronoi::Point>`
        .with_vertices(p.iter())?
        // `with_segments()` accepts iterators of anything that
        //  implements `Into<boostvoronoi::Line>`
        .with_segments(s.iter())?
        // this will generate the list of cells, edges and circle
        // events (aka vertices)
        .build()?;
    println!(
        "Result: cells:{}, edges:{}, vertices:{}",
        diagram.cells().len(),
        diagram.edges().len(),
        diagram.vertices().len()
    );
    // The values inside the diagram are wrapped in `Rc<Cell<T>>`
    for cell in diagram.cells().iter().map(|c| c.get()) {
        println!("Cell : {}", cell.id().0);
        for edge_id in diagram.cell_edge_iterator(cell.id()) {
            let edge = diagram.get_edge(edge_id)?.get();
            // The vertices of an edge will have the value `None`
            // if they are infinitely far away.
            println!(
                "  edge: {}, from:{:?} to:{:?}",
                edge_id.0,
                edge.vertex0(),
                diagram.edge_get_vertex1(edge_id)?
            );
        }
    }
    Ok(())
}

Edges will become curves when line segments are used as input, see the example code for discretization and interpolation.

Minimum Supported Rust Version (MSRV)

The minimum supported version of Rust for boostvoronoi is 1.66.

Todo

  • Try to fix the known problems in C++ Boost voronoi and port over.
  • Add many more test cases for voronoi_robust_ftp.rs.
  • Benchmark and optimize.
  • Replace C++ style boolean ordering functors.
  • Replace builtin ulp with some rust crate (approx?).
  • Take care of the todo: tags.
  • Builder pattern
  • Hide implementation details with a workspace (w/o disabling doc-tests)
  • Add serde to SyncDiagram and other diagram types.
  • Specific type conversion tests (cgmath,glam,mint & geo)

All credit goes to the original author (Andrii Sydorchuk) and the boost contributors, except the porting mistakes. They are all mine.

Commit count: 0

cargo fmt