Struct RTreeBuilder 

pub struct RTreeBuilder<N: IndexableNum> { /* private fields */ }

A builder to create an RTree.

use geo_index::rtree::RTreeBuilder;
use geo_index::rtree::sort::HilbertSort;

let mut builder = RTreeBuilder::<f64>::new(3);
builder.add(0., 0., 2., 2.);
builder.add(1., 1., 3., 3.);
builder.add(2., 2., 4., 4.);
let tree = builder.finish::<HilbertSort>();

Implementations

impl<N: IndexableNum> RTreeBuilder<N>

pub fn new(num_items: u32) -> Self

Create a new builder with the provided number of items and the default node size.

pub fn new_with_node_size(num_items: u32, node_size: u16) -> Self

Create a new builder with the provided number of items and node size.

pub fn from_metadata(metadata: RTreeMetadata<N>) -> Self

Create a new builder with the provided metadata

pub fn metadata(&self) -> &RTreeMetadata<N>

Access the underlying RTreeMetadata of this instance.

pub fn add(&mut self, min_x: N, min_y: N, max_x: N, max_y: N) -> u32

Add a given rectangle to the RTree.

This returns the insertion index, which provides a lookup back into the original data.

RTreeIndex::search will return this same insertion index, which allows you to reference your original collection.

pub fn add_rect(&mut self, rect: &impl RectTrait<T = N>) -> u32

Add a given rectangle to the RTree.

This returns the insertion index, which provides a lookup back into the original data.

RTreeIndex::search will return this same insertion index, which allows you to reference your original collection.

pub fn finish<S: Sort<N>>(self) -> RTree<N>

Consume this builder, perfoming the sort and generating an RTree ready for queries.

HilbertSort and STRSort both implement Sort, allowing you to choose the method used.