Skip to main content

BoundingBox

Struct BoundingBox 

Source
pub struct BoundingBox {
    pub min_lat: f64,
    pub max_lat: f64,
    pub min_lon: f64,
    pub max_lon: f64,
}
Expand description

An axis-aligned geographic bounding box defined by min/max lat and lon.

Coordinates are in degrees (latitude: [-90, 90], longitude: [-180, 180]). This struct does not handle anti-meridian crossing (bounding boxes that wrap around longitude ±180°). For those use cases, split into two boxes.

§Examples

use scirs2_spatial::geo::BoundingBox;

let bbox = BoundingBox::new(48.0, 52.0, -1.0, 3.0).unwrap();
assert!(bbox.contains(50.0, 1.0));
assert!(!bbox.contains(53.0, 1.0));

Fields§

§min_lat: f64

Minimum latitude in degrees

§max_lat: f64

Maximum latitude in degrees

§min_lon: f64

Minimum longitude in degrees

§max_lon: f64

Maximum longitude in degrees

Implementations§

Source§

impl BoundingBox

Source

pub fn new( min_lat: f64, max_lat: f64, min_lon: f64, max_lon: f64, ) -> SpatialResult<Self>

Create a new BoundingBox.

§Arguments
  • min_lat - Minimum latitude in degrees
  • max_lat - Maximum latitude in degrees
  • min_lon - Minimum longitude in degrees
  • max_lon - Maximum longitude in degrees
§Errors

Returns SpatialError::ValueError if:

  • min_lat > max_lat
  • min_lon > max_lon
  • Any value is out of range (lat ∉ [-90, 90], lon ∉ [-180, 180])
Source

pub fn from_points(points: &[(f64, f64)]) -> SpatialResult<Self>

Create a BoundingBox from a set of geographic points.

§Arguments
  • points - Slice of (lat, lon) pairs in degrees
§Errors

Returns SpatialError::ValueError if the slice is empty.

Source

pub fn contains(&self, lat: f64, lon: f64) -> bool

Test whether a geographic point is inside (or on the boundary of) this box.

§Arguments
  • lat - Latitude in degrees
  • lon - Longitude in degrees
Source

pub fn intersects(&self, other: &BoundingBox) -> bool

Test whether two bounding boxes overlap (share any area or boundary point).

Source

pub fn expand(&self, margin_deg: f64) -> SpatialResult<BoundingBox>

Return a new BoundingBox expanded by margin_deg degrees in all four directions.

Clamps the result to valid lat/lon ranges so the returned box is always valid.

§Arguments
  • margin_deg - Expansion amount in degrees (must be ≥ 0)
§Errors

Returns SpatialError::ValueError if margin_deg is negative.

Source

pub fn center(&self) -> (f64, f64)

Return the center (lat, lon) of the bounding box.

Source

pub fn width_deg(&self) -> f64

Return the width of the bounding box in degrees (longitude span).

Source

pub fn height_deg(&self) -> f64

Return the height of the bounding box in degrees (latitude span).

Source

pub fn area_m2(&self) -> f64

Approximate area of the bounding box in square metres.

Uses the spherical Earth model. Suitable for boxes up to a few hundred km wide.

Trait Implementations§

Source§

impl Clone for BoundingBox

Source§

fn clone(&self) -> BoundingBox

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BoundingBox

Source§

impl Debug for BoundingBox

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for BoundingBox

Source§

fn eq(&self, other: &BoundingBox) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for BoundingBox

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V