Trait spatial::tree::mbr::MbrLeafGeometry [] [src]

pub trait MbrLeafGeometry<P, DIM: ArrayLength<P> + ArrayLength<(P, P)>> {
    fn dim(&self) -> usize;
    fn area(&self) -> P;
    fn min_for_axis(&self, dim: usize) -> P;
    fn max_for_axis(&self, dim: usize) -> P;
    fn expand_mbr_to_fit(&self, mbr: &mut Rect<P, DIM>);
    fn distance_from_mbr_center(&self, mbr: &Rect<P, DIM>) -> P;
    fn contained_by_mbr(&self, mbr: &Rect<P, DIM>) -> bool;
    fn overlapped_by_mbr(&self, mbr: &Rect<P, DIM>) -> bool;
    fn area_overlapped_with_mbr(&self, mbr: &Rect<P, DIM>) -> P;
}

The minimum functionality required to insert leaf geometry into MbrMap Until the rust compiler allows compile-time generic integers, we'll be using generic_array's ArrayLength to specify geometry dimensions at compile time.

The parameter mbr represents a minimum bounding rectangle. An mbr whose corners are at (x1, y1), (x2, y2) will have the corresponding edges: (x1, x2), (y1, y2)

Required Methods

fn dim(&self) -> usize

The geometry's dimension count

fn area(&self) -> P

Determine the area of the geometry

fn min_for_axis(&self, dim: usize) -> P

the minimum extent for a given axis

fn max_for_axis(&self, dim: usize) -> P

the maximum extent for a given axis

fn expand_mbr_to_fit(&self, mbr: &mut Rect<P, DIM>)

Expand the mbr to minimally fit the leaf

fn distance_from_mbr_center(&self, mbr: &Rect<P, DIM>) -> P

Determine the distance from the mbr's center

fn contained_by_mbr(&self, mbr: &Rect<P, DIM>) -> bool

Determine if the leaf is completely contained in the mbr

fn overlapped_by_mbr(&self, mbr: &Rect<P, DIM>) -> bool

Determine if the leaf overlaps the mbr

fn area_overlapped_with_mbr(&self, mbr: &Rect<P, DIM>) -> P

Determines the leaf area shared with the rectangle. In cases where the leaf and mbr overlap, but the leaf has no area (point or a line, for example), return 0

Implementors