Struct BBox 

pub struct BBox<T = f64> {
    pub left: T,
    pub bottom: T,
    pub right: T,
    pub top: T,
}

Bounding Box

Description

A Bounding Box ensures a min-max range of values

The order is (left, bottom, right, top) when storing as a flattened array.

If WM, then the projection is lon-lat. If S2, then the projection is s-t

Defaults to f64 as the base type.

Implements MValueCompatible

Usage

From/To

• MValue
• ValueType

Any Type BBox

• BBox::new: Creates a new BBox
• BBox::point_overlap: Checks if a point is within the BBox
• BBox::merge: Merges another bounding box with this one
• BBox::merge_in_place: Merges in place another bounding box with this one
• BBox::overlap: Checks if another bounding box overlaps with this one
• BBox::clip: Clips the bounding box along an axis
• BBox::inside: Checks if this bounding box is inside another
• BBox::area: Returns the area of the bounding box

f64 Type BBox

Note that all the input geometry uses the GetXY trait.

• BBox::from_point: Creates a new BBox from a point
• BBox::from_linestring: Creates a new BBox from a linestring
• BBox::from_multi_linestring: Creates a new BBox from a multi-linestring
• BBox::from_polygon: Creates a new BBox from a polygon
• BBox::from_multi_polygon: Creates a new BBox from a multi-polygon
• BBox::extend_from_point: Extends the bounding box with a point
• BBox::from_uv_zoom: Creates a new BBox from zoom-uv coordinates
• BBox::from_st_zoom: Creates a new BBox from zoom-st coordinates

Fields

left: T

left most longitude (WM) or S (S2)

bottom: T

bottom most latitude (WM) or T (S2)

right: T

right most longitude (WM) or T (S2)

top: T

top most latitude (WM) or S (S2)

Implementations

impl<T> BBox<T>

pub fn new(left: T, bottom: T, right: T, top: T) -> Self

where T: Copy,

Creates a new BBox

pub fn point_overlap<P: GetXY>(&self, point: &P) -> bool

where T: Into<f64> + Copy,

Checks if a point is within the BBox

pub fn merge(&self, other: &Self) -> Self

where T: PartialOrd + Copy,

Merges another bounding box with this one

pub fn merge_in_place(&mut self, other: &Self)

where T: PartialOrd + Copy,

Merges in place another bounding box with this one

pub fn overlap(&self, other: &BBox<T>) -> Option<BBox<T>>

where T: PartialOrd + Copy,

Checks if another bounding box overlaps with this one and returns the overlap

pub fn clip(&self, axis: Axis, k1: T, k2: T) -> BBox<T>

where T: PartialOrd + Copy,

Clips the bounding box along an axis

pub fn inside(&self, other: &BBox<T>) -> bool

where T: PartialOrd + Copy,

Checks if this bounding box is inside another

pub fn area(&self) -> T

where T: Sub<Output = T> + Mul<Output = T> + Copy,

Returns the area of the bounding box

impl BBox<f64>

pub fn from_point<P: GetXY>(point: &P) -> Self

Creates a new BBox from a point

pub fn from_linestring<P: GetXY>(line: &[P]) -> Self

Creates a new BBox from a linestring

pub fn from_multi_linestring<P: GetXY>(lines: &[Vec<P>]) -> Self

Creates a new BBox from a multi-linestring

pub fn from_polygon<P: GetXY>(polygon: &[Vec<P>]) -> Self

Creates a new BBox from a polygon

pub fn from_multi_polygon<P: GetXY>(polygons: &[Vec<Vec<P>>]) -> Self

Creates a new BBox from a multi-polygon

pub fn extend_from_point<P: GetXY>(&mut self, point: &P)

Extends the bounding box with a point

pub fn from_uv_zoom(u: f64, v: f64, zoom: u8) -> Self

Creates a new BBox from zoom-uv coordinates

pub fn from_st_zoom(s: f64, t: f64, zoom: u8) -> Self

Creates a new BBox from zoom-st coordinates

Trait Implementations

impl<T: Clone> Clone for BBox<T>

fn clone(&self) -> BBox<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for BBox<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for BBox<T>

where T: Default + Bounded + Copy,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for BBox<T>

where T: Deserialize<'de> + Copy,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<&BBox<T>> for MValue

where T: Copy + Into<ValueType>,

fn from(bbox: &BBox<T>) -> MValue

Converts to this type from the input type.

impl<T> From<&Map<String, ValueType>> for BBox<T>

where T: From<ValueType>,

fn from(mvalue: &MValue) -> Self

Converts to this type from the input type.

impl<T: Default + Copy> From<BBox<T>> for BBox3D<T>

fn from(bbox: BBox<T>) -> Self

Converts to this type from the input type.

impl<T> From<BBox<T>> for MValue

where T: Into<ValueType>,

fn from(bbox: BBox<T>) -> MValue

Converts to this type from the input type.

impl From<BBox> for BBOX

fn from(bbox: BBox) -> Self

Converts to this type from the input type.

impl<T: Copy> From<BBox3D<T>> for BBox<T>

fn from(bbox: BBox3D<T>) -> Self

Converts to this type from the input type.

impl<T> From<Map<String, ValueType>> for BBox<T>

where T: From<ValueType>,

fn from(mvalue: MValue) -> Self

Converts to this type from the input type.

impl<T: Interpolate> Interpolate for BBox<T>

fn interpolate(&self, other: &Self, t: f64) -> Self

Interpolate between two of the same type

impl<T: PartialEq> PartialEq for BBox<T>

fn eq(&self, other: &BBox<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for BBox<T>

fn partial_cmp(&self, other: &BBox<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for BBox<T>

where T: Serialize + Copy,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for BBox<T>

impl<T> MValueCompatible for BBox<T>

where ValueType: From<T>, T: From<ValueType> + Default + Bounded + Copy + Interpolate,

impl<T> StructuralPartialEq for BBox<T>