Struct smeagol::BoundingBox

pub struct BoundingBox { /* fields omitted */ }

A rectangular region of a Life grid.

Methods

impl BoundingBox

pub fn new(upper_left: Position, lower_right: Position) -> Self

Creates a new bounding box with the given upper-left corner position and lower-right corner position.

Examples

// create a bounding box around a single position
let pos = smeagol::Position::new(0, 0);
let bounding_box = smeagol::BoundingBox::new(pos, pos);

pub fn upper_left(&self) -> Position

Returns the upper left corner position of the bounding box.

pub fn lower_right(&self) -> Position

Returns the lower right corner position of the bounding box.

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

Combines two bounding boxes, returning a bounding box that surrounds both boxes.

Examples

let p0 = smeagol::Position::new(0, 0);
let p1 = smeagol::Position::new(1, 1);

let bbox0 = smeagol::BoundingBox::new(p0, p0);
let bbox1 = smeagol::BoundingBox::new(p1, p1);

assert_eq!(bbox0.combine(bbox1), smeagol::BoundingBox::new(p0, p1));

pub fn intersect(&self, other: BoundingBox) -> Option<Self>

Intersects two bounding boxes, returning a bounding box that both boxes contain.

pub fn offset(&self, x_offset: i64, y_offset: i64) -> Self

Offsets the bounding box by the given amounts in the x and y directions.

Examples

let p0 = smeagol::Position::new(0, 0);
let p1 = smeagol::Position::new(2, 2);
let bbox = smeagol::BoundingBox::new(p0, p1);
let offset_bbox = bbox.offset(3, 4);

pub fn pad(&self, amount: i64) -> Self

Pads the outside of the bounding box by the given amount.

Panics

Panics if amount < 0.

Examples

let p0 = smeagol::Position::new(0, 0);
let p1 = smeagol::Position::new(2, 2);
let bbox = smeagol::BoundingBox::new(p0, p1);
let padded_bbox = bbox.pad(5);

Trait Implementations

impl PartialEq<BoundingBox> for BoundingBox

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Ord for BoundingBox

fn cmp(&self, other: &BoundingBox) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

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

impl Copy for BoundingBox

impl PartialOrd<BoundingBox> for BoundingBox

fn partial_cmp(&self, other: &BoundingBox) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Hash for BoundingBox

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for BoundingBox

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

Formats the value using the given formatter.