Struct BoundingBox

pub struct BoundingBox {
    pub x: f32,
    pub y: f32,
    pub w: f32,
    pub h: f32,
}

Represents an axis-aligned bounding box.

Fields

x: f32

The horizontal x position of the bounding box.

y: f32

The vertical y position of the bounding box.

w: f32

The width of the bounding box.

h: f32

The height of the bounding box.

Implementations

impl BoundingBox

pub fn from_min_max( min_x: f32, min_y: f32, max_x: f32, max_y: f32, ) -> BoundingBox

Construct a BoundingBox from checked minimum and maximum values.

pub fn left(&self) -> f32

Left side of bounds equivalent to x.

pub fn top(&self) -> f32

Top of bounds equivalent to y.

pub fn width(&self) -> f32

Bounds width equivalent to w.

pub fn height(&self) -> f32

Bounds height equivalent to h.

pub fn right(&self) -> f32

Right side of bounds.

pub fn bottom(&self) -> f32

Bottom side of bounds.

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

Horizontal and vertical center of bounds.

pub fn center_left(&self) -> (f32, f32)

Left center of bounds.

pub fn center_right(&self) -> (f32, f32)

Right center of bounds.

pub fn center_top(&self) -> (f32, f32)

Top center of bounds.

pub fn center_bottom(&self) -> (f32, f32)

Bottom center of bounds.

pub fn bottom_left(&self) -> (f32, f32)

Bottom left point of bounds.

pub fn bottom_right(&self) -> (f32, f32)

Bottom right point of bounds.

pub fn top_left(&self) -> (f32, f32)

Top left point of bounds.

pub fn top_right(&self) -> (f32, f32)

Top right point of bounds.

pub fn shrink(&self, amount: f32) -> BoundingBox

Shrinks by some amount in both directions and returns a new BoundingBox.

pub fn shrink_horizontal(&self, amount: f32) -> BoundingBox

Shrinks by some amount horizontally and returns a new BoundingBox.

pub fn shrink_vertical(&self, amount: f32) -> BoundingBox

Shrinks by some amount vertically and returns a new BoundingBox.

pub fn shrink_sides( &self, left: f32, top: f32, right: f32, bottom: f32, ) -> BoundingBox

Shrinks each side by the given separate amounts and returns a new BoundingBox.

pub fn expand_sides( &self, left: f32, top: f32, right: f32, bottom: f32, ) -> BoundingBox

Expands each side by the given separate amounts and returns a new BoundingBox.

pub fn offset(&self, x: f32, y: f32) -> BoundingBox

Shifts the bounding box by the given X and Y offsets and returns a new BoundingBox.

pub fn expand(&self, amount: f32) -> BoundingBox

Expands by some amount in both directions and returns a new BoundingBox.

pub fn expand_horizontal(&self, amount: f32) -> BoundingBox

Expands by some amount horizontally and returns a new BoundingBox.

pub fn expand_vertical(&self, amount: f32) -> BoundingBox

Expands by some amount vertically and returns a new BoundingBox.

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

Returns a new BoundingBox representing the intersection of the current bounding box and the given bounding box.

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

Returns a new BoundingBox representing the union of the current bounding box and the given bounding box.

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

Returns true if the current bounding box and the given bounding box intersect.

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

Returns true if the given bounding box is contained within the current bounding box.

pub fn contains_point(&self, x: f32, y: f32) -> bool

Returns true if the given point is contained within the current bounding box.

pub fn diagonal(&self) -> f32

Because the diagonal distance of the current bounding box.

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<(), Error>

Formats the value using the given formatter.

impl Default for BoundingBox

fn default() -> BoundingBox

Returns the “default value” for a type.

impl Display for BoundingBox

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

Formats the value using the given formatter.

impl From<BoundingBox> for Rect

fn from(bb: BoundingBox) -> Rect

Converts to this type from the input type.

impl From<Rect> for BoundingBox

fn from(bb: Rect) -> BoundingBox

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 StructuralPartialEq for BoundingBox