Struct BBox 

pub struct BBox {
    pub min_x: f64,
    pub min_y: f64,
    pub max_x: f64,
    pub max_y: f64,
}

An axis-aligned bounding box, stored as its minimum corner plus its extent.

The min / max form (rather than x / y / width / height) keeps the empty-box case representable: a box that has not been extended yet is min > max on every axis, which is the standard sentinel for “no geometry yet”.

Fields

min_x: f64

The smallest x reached by the geometry.

min_y: f64

The smallest y reached by the geometry.

max_x: f64

The largest x reached by the geometry.

max_y: f64

The largest y reached by the geometry.

Implementations

impl BBox

Inherent implementation of BBox.

pub fn empty() -> Self

Returns an empty bounding box.

The empty box has min greater than max on both axes, which makes BBox::extend_point work without a special case for the first vertex.

pub fn from_min_size(min_x: f64, min_y: f64, width: f64, height: f64) -> Self

Returns a bounding box from its minimum corner and its extent.

Arguments

• f64 - A 64-bit float (f64).

pub fn from_corners(x0: f64, y0: f64, x1: f64, y1: f64) -> Self

Returns a bounding box from two opposite corners.

Arguments

• f64 - A 64-bit float (f64).

pub fn is_empty(&self) -> bool

Returns true when the box contains no geometry.

Returns

• bool - A boolean.

pub fn width(&self) -> f64

Returns the width of the box, or zero when it is empty.

Returns

• f64 - A 64-bit float.

pub fn height(&self) -> f64

Returns the height of the box, or zero when it is empty.

Returns

• f64 - A 64-bit float.

pub fn center_x(&self) -> f64

Returns the horizontal center of the box.

Returns

• f64 - A 64-bit float.

pub fn center_y(&self) -> f64

Returns the vertical center of the box.

Returns

• f64 - A 64-bit float.

pub fn extend_point(&mut self, x: f64, y: f64)

Grows the box so that it contains the given point.

Arguments

• f64 - A 64-bit float (f64).

pub fn extend_box(&mut self, other: &BBox)

Grows the box so that it contains the given box.

Arguments

• &BBox - Shared reference to a BBox.

pub fn contains(&self, x: f64, y: f64) -> bool

Returns true when the box fully contains the given point.

Arguments

• f64 - A 64-bit float (f64).

Returns

• bool - A boolean.

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

Returns true when the two boxes overlap.

Arguments

• &BBox - Shared reference to a BBox.

Returns

• bool - A boolean.

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

Returns the overlap of the two boxes, or None when they do not overlap.

Arguments

• &BBox - Shared reference to a BBox.

Returns

• Option<BBox> - Some(...) on success, None otherwise.

pub fn union(&self, other: &BBox) -> BBox

Returns the union of the two boxes.

Arguments

• &BBox - Shared reference to a BBox.

Returns

• BBox - A BBox value.

impl BBox

pub fn get_min_x(&self) -> f64

pub fn get_mut_min_x(&mut self) -> &mut f64

pub fn set_min_x(&mut self, val: f64) -> &mut Self

pub fn get_min_y(&self) -> f64

pub fn get_mut_min_y(&mut self) -> &mut f64

pub fn set_min_y(&mut self, val: f64) -> &mut Self

pub fn get_max_x(&self) -> f64

pub fn get_mut_max_x(&mut self) -> &mut f64

pub fn set_max_x(&mut self, val: f64) -> &mut Self

pub fn get_max_y(&self) -> f64

pub fn get_mut_max_y(&mut self) -> &mut f64

pub fn set_max_y(&mut self, val: f64) -> &mut Self

Trait Implementations

impl Clone for BBox

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BBox

impl Debug for BBox

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

Formats the value using the given formatter.

impl Default for BBox

Default construction for BBox.

fn default() -> Self

Constructs a default BBox value.

impl PartialEq for BBox

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BBox