Struct BoundingBox

pub struct BoundingBox { /* private fields */ }

Defines a rectangular bounding box.

The Y axis convention is downwards.

Implementations

impl BoundingBox

pub fn new(center: Point, width: f64, height: f64) -> Self

Constructs a new bounding box.

Arguments

• center - The position of the center of the bounding box
• width - The bounding box’s width
• height - The bounding box’s height

pub fn new_centered(width: f64, height: f64) -> Self

Constructs a new bounding box centeterd at origin with the provided width and height.

pub fn new_centered_square(width: f64) -> Self

Constructs a new square bounding box centeterd at origin with the provided width.

pub fn center(&self) -> &Point

Gets the position of the box’s center.

pub fn top_right(&self) -> &Point

Gets the position of the top right corner of the bounding box.

pub fn bottom_left(&self) -> &Point

Gets the position of the bottom left corner of the bounding box.

pub fn width(&self) -> f64

Gets the width of the bounding box.

pub fn height(&self) -> f64

Gets the height of the bounding box.

pub fn top(&self) -> f64

Gets the Y coordinate of the top of the bounding box.

pub fn bottom(&self) -> f64

Gets the Y coordinate of the bottom of the bounding box.

pub fn left(&self) -> f64

Gets the X coordinate of the left of the bounding box.

pub fn right(&self) -> f64

Gets the X coordinate of the right of the bounding box.

pub fn corners(&self) -> [Point; 4]

Gets a slice of corners oriented counter-clockwise.

pub fn is_inside(&self, point: &Point) -> bool

Returns whether a given point is inside (or on the edges) of the bounding box.

pub fn is_exclusively_inside(&self, point: &Point) -> bool

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

fn default() -> Self

Returns the “default value” for a type.