Struct BoundingBox

pub struct BoundingBox { /* private fields */ }

Implementations

impl BoundingBox

pub fn from_coordinates(coordinates: &[FPCoordinate]) -> BoundingBox

pub fn invalid() -> BoundingBox

pub fn extend_with(&mut self, other: &BoundingBox)

pub fn center(&self) -> FPCoordinate

pub fn contains(&self, coordinate: &FPCoordinate) -> bool

Tests if a coordinate lies within the bounding box

A coordinate is considered inside if it lies within or on the boundaries of the bounding box.

Arguments

• coordinate - The coordinate to test

Returns

true if the coordinate is inside or on the boundary, false otherwise

Examples

use toolbox_rs::geometry::FPCoordinate;
use toolbox_rs::bounding_box::BoundingBox;

let bbox = BoundingBox::from_coordinates(&[
    FPCoordinate::new(10, 10),
    FPCoordinate::new(20, 20),
]);

assert!(bbox.contains(&FPCoordinate::new(15, 15))); // inside
assert!(bbox.contains(&FPCoordinate::new(10, 10))); // on boundary
assert!(!bbox.contains(&FPCoordinate::new(5, 15))); // outside

pub fn min_distance(&self, coordinate: &FPCoordinate) -> f64

Calculates the minimum distance from a coordinate to the bounding box

If the coordinate lies inside the bounding box, the distance is 0. Otherwise, it returns the shortest distance to any part of the box’s boundary.

Arguments

• coordinate - The coordinate to measure distance to

Returns

The minimum distance in kilometers

Examples

use toolbox_rs::geometry::FPCoordinate;
use toolbox_rs::bounding_box::BoundingBox;

let bbox = BoundingBox::from_coordinates(&[
    FPCoordinate::new_from_lat_lon(50.0, 10.0),
    FPCoordinate::new_from_lat_lon(51.0, 11.0),
]);

// Point inside -> distance is 0
let inside = FPCoordinate::new_from_lat_lon(50.5, 10.5);
assert_eq!(bbox.min_distance(&inside), 0.0);

// Point outside -> positive distance
let outside = FPCoordinate::new_from_lat_lon(49.0, 10.5);
assert!(bbox.min_distance(&outside) > 0.0);

pub fn is_valid(&self) -> bool

pub fn from_coordinate(coordinate: &FPCoordinate) -> BoundingBox

Trait Implementations

impl Clone for BoundingBox

fn clone(&self) -> BoundingBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundingBox

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

Formats the value using the given formatter.

impl From<&BoundingBox> for Bbox

fn from(bbox: &BoundingBox) -> Bbox

Converts to this type from the input type.

impl PartialEq for BoundingBox

fn eq(&self, other: &BoundingBox) -> 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 Copy for BoundingBox

impl Eq for BoundingBox

impl StructuralPartialEq for BoundingBox