Type Definition lowdim::BBox2d

pub type BBox2d<S = i64> = BBox<S, Vec2d<S>>;

A 2d bounding box.

Implementations

impl<S> BBox2d<S> where
    S: Integer, 

pub fn from_bounds(x_start: S, x_end: S, y_start: S, y_end: S) -> BBox2d<S>

Constructs a bounding box from bounds.

As always, lower bounds are inclusive, upper bounds exclusive.

pub fn x_start(&self) -> S

Returns the lower bound in the x-coordinate (inclusive).

pub fn x_end(&self) -> S

Returns the upper bound in the x-coordinate (exclusive).

pub fn x_min(&self) -> S

Returns the lower bound in the x-coordinate (inclusive).

pub fn x_max(&self) -> S

Returns the upper bound in the x-coordinate (inclusive).

pub fn x0(&self) -> S

👎 Deprecated:

Use x_start or x_min instead.

Returns the lower bound in the x-coordinate (inclusive).

pub fn x1(&self) -> S

👎 Deprecated:

Use x_end instead, or consider using x_max.

Returns the upper bound in the x-coordinate (exclusive).

pub fn y_start(&self) -> S

Returns the lower bound in the y-coordinate (inclusive).

pub fn y_end(&self) -> S

Returns the upper bound in the y-coordinate (exclusive).

pub fn y_min(&self) -> S

Returns the lower bound in the y-coordinate (inclusive).

pub fn y_max(&self) -> S

Returns the upper bound in the y-coordinate (inclusive).

pub fn y0(&self) -> S

👎 Deprecated:

Use y_start or y_min instead.

Returns the lower bound in the y-coordinate (inclusive).

pub fn y1(&self) -> S

👎 Deprecated:

Use y_end instead, or consider using y_max.

Returns the upper bound in the y-coordinate (exclusive).

pub fn x_len(&self) -> usize where
    usize: TryFrom<S>, 

Returns the width of the bounding box.

pub fn y_len(&self) -> usize where
    usize: TryFrom<S>, 

Returns the height of the bounding box.

pub fn area(&self) -> usize where
    usize: TryFrom<S>, 

Returns the area of the bounding box.

pub fn contains(&self, p: &Point2d<S>) -> bool

Returns true if the point is inside the bounding box.

pub fn x_range(&self) -> Range<S>

The range of the x coordinate

pub fn y_range(&self) -> Range<S>

The range of the y coordinate

pub fn iter(&self) -> Iter<'_, S> where
    usize: TryFrom<S>, 

Returns an iterator over the points in the bounding box.

Points are returned by row.

pub fn seq_index(&self, p: Point2d<S>) -> usize where
    usize: TryFrom<S>, 

Returns the sequential index for a given point.

Points are counted by row.

Trait Implementations

impl<'a, S: Integer> IntoIterator for &'a BBox2d<S> where
    usize: TryFrom<S>, 

type Item = Point2d<S>

The type of the elements being iterated over.

type IntoIter = Iter<'a, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.