Enum SpatialIndex 

pub enum SpatialIndex {
    VertexOrientedIndex {
        rtree: RTree<MapVertexRTreeObject>,
        tolerance: Option<Length>,
    },
    EdgeOrientedIndex {
        rtree: RTree<MapEdgeRTreeObject>,
        tolerance: Option<Length>,
    },
}

Variants

VertexOrientedIndex

Fields

rtree: RTree<MapVertexRTreeObject>

tolerance: Option<Length>

EdgeOrientedIndex

Fields

rtree: RTree<MapEdgeRTreeObject>

tolerance: Option<Length>

Implementations

impl SpatialIndex

pub fn build( spatial_index_type: &SpatialIndexType, graph: Arc<Graph>, geometry_models: &[GeometryModel], tolerance: Option<Length>, ) -> SpatialIndex

build a spatial index of the declared SpatialIndexType

pub fn new_vertex_oriented( vertices: &[Vertex], tolerance: Option<Length>, ) -> Self

creates a new instance of the rtree model that is vertex-oriented; that is, the rtree is built over the vertices in the graph, and nearest neighbor searches return a VertexId.

pub fn new_edge_oriented( graph: Arc<Graph>, geometry_models: &[GeometryModel], tolerance: Option<Length>, ) -> Self

creates a new instance of the rtree model that is edge-oriented; that is, the rtree is built over the edges in the graph, and nearest neighbor searches return the edge’s destination vertex.

• future work: make SearchOrientation set which incident vertex is returned.

pub fn nearest_graph_id( &self, point: &Point<f32>, ) -> Result<NearestSearchResult, MapError>

gets the nearest graph id, which is a VertexId or EdgeId depending on the orientation of the RTree.

pub fn nearest_graph_id_iter<'a>( &'a self, point: &'a Point<f32>, ) -> Box<dyn Iterator<Item = Result<NearestSearchResult, MapError>> + 'a>

builds an iterator over map edges ordered by nearness to the given point. applies the (map-matching) distance tolerance filter.

pub fn is_edge_oriented(&self) -> bool

Returns true if this is an edge-oriented spatial index.