#gis #geo #geography #geospatial

geo-booleanop

Rust implementation of the Martinez-Rueda Polygon Clipping Algorithm

7 releases

0.3.2 Jun 27, 2020
0.3.0 May 18, 2020
0.2.2 Apr 28, 2020
0.2.0 Jul 2, 2019
0.1.4 Jan 22, 2019

#194 in Science

Download history 36/week @ 2021-08-13 35/week @ 2021-08-20 33/week @ 2021-08-27 48/week @ 2021-09-03 40/week @ 2021-09-10 46/week @ 2021-09-17 69/week @ 2021-09-24 12/week @ 2021-10-01 34/week @ 2021-10-08 22/week @ 2021-10-15 51/week @ 2021-10-22 23/week @ 2021-10-29 28/week @ 2021-11-05 23/week @ 2021-11-12 23/week @ 2021-11-19 20/week @ 2021-11-26

104 downloads per month
Used in 3 crates

MIT license

105KB
2.5K SLoC

Build Status crates.io

Boolean operations on geo shapes

This is an implementation of the Martinez-Rueda Polygon Clipping Algorithm in rust to integrate smoothly into the already exsting geospatial library georust/geo.

In fact the implementation closely follows the "reference" implementation in JavaScript: https://github.com/w8r/martinez. Most of the concepts and fixtures have been taken from there.

At the moment the implementation contains its own splay tree implementation (adapted from https://github.com/alexcrichton/splay-rs) as the JavaScript implementation also uses a splay-tree. This might be refactored out in the future in favor of the standard collection types (like BTreeSet).

IMPORTANT: How to report bugs

Please be aware (so far) this implementation is based on the JavaScript version. If you find a bug (i.e. two polygons not producing the expected result), chances are that the original algorithm has the same problem. So please first check with https://github.com/w8r/martinez and file a report there. Once there is a fix I will happily backport it to the rust version.

If you do not know how to do that (You understand rust but not javascript? ... I mean ... seriously?), you may take a look at this example: https://gist.github.com/untoldwind/e95b7eff8ad61527a5dc4bdd889169b0

I.e. just create package.json, ìnsert your example coordinates in main.js and then do npm install followed by node main.js

Usage

Pretty straightforward:

geo-booleanop = "0.2.1"
extern create geo;
extern crate geo_booleanop;

use geo_booleanop::boolean::BooleanOp;

fn main() {
    let poly1 : geo::Polygon<f64> = ...
    let poly2 : geo::Polygon<f64> = ...

    let intersect = poly1.intersection(&poly2);
    let union = poly1.union(&poly2);
    let diff = poly1.difference(&poly2);
    let xor = poly1.xor(&poly2);

    ...
}

MultiPolygon is supported as well.

Dependencies

~390KB