Struct Prepared 

pub struct Prepared<'a, G: Preparable + ?Sized> { /* private fields */ }

A geometry prepared for repeated queries: a spatial index over its segments and rings.

Build it once for a geometry queried many times (a zone fill checked against every pad, track and via in DRC); every method returns exactly what the free function of the same name returns with the prepared geometry as first argument, closest points included, at a cost that follows the size of the other operand and of the prepared geometry near it rather than the size of the whole prepared geometry.

Building costs about as much as a few free-function queries (O(n log n) for n segments); contains and distance also compute a little more on their first call. A Prepared is Send + Sync when the geometry is.

use polyclip::*;
let zone = Polygon::new(
    Ring::from([(0, 0), (1000, 0), (1000, 1000), (0, 1000)]),
    vec![Ring::from([(400, 400), (400, 600), (600, 600), (600, 400)])],
);
let prepared = Prepared::new(&zone);
let pad = Ring::from([(450, 450), (550, 450), (550, 550), (450, 550)]);
assert!(!prepared.intersects(&pad));
assert!(prepared.distance_less_than(&pad, 51));
assert!(!prepared.distance_less_than(&pad, 50));
assert_eq!(prepared.locate(Point::new(500, 500)), Location::Outside);
assert_eq!(prepared.distance_less_than(&pad, 51), distance_less_than(&zone, &pad, 51));

Implementations

impl<'a, G: Preparable + ?Sized> Prepared<'a, G>

pub fn new(geom: &'a G) -> Self

Indexes geom.

pub fn geometry(&self) -> &'a G

The prepared geometry.

pub fn locate(&self, p: Point) -> Location

Location of p relative to the prepared geometry: locate(g, p).

pub fn intersects<B: Geometry + ?Sized>(&self, b: &B) -> bool

true when the prepared geometry and b share a point: intersects(g, b).

pub fn distance_less_than<B: Geometry + ?Sized>(&self, b: &B, d: i64) -> bool

true when the distance between the prepared geometry and b is less than d: distance_less_than(g, b, d).

pub fn contains<B: Geometry + ?Sized>(&self, b: &B) -> bool

true when every point of b belongs to the prepared geometry: contains(g, b).

pub fn distance<B: Geometry + ?Sized>(&self, b: &B) -> Option<Closest>

Exact minimum distance between the prepared geometry and b, with a pair of closest points: distance(g, b), the same pair included.