Struct lowdim::BBox

pub struct BBox<S: Integer, V: Vector<S>> { /* fields omitted */ }

A bounding box.

An axis-aligned non-empty volume of the same dimension as the space.

Implementations

impl<S, V> BBox<S, V> where
    S: Integer,
    V: Vector<S>, 

pub fn new(origin: Point<S, V>, size: V) -> BBox<S, V>

Constructs a bounding box from origin and size.

All coordinates of size must be positive to make the box non-empty.

pub fn from_point(p: Point<S, V>) -> BBox<S, V>

Constructs a bounding box which contains a single point.

Example

let p = p2d(2, 3);
assert_eq!(bb2d(2..3, 3..4), BBox2d::from_point(p));

pub fn from_points(p0: Point<S, V>, p1: Point<S, V>) -> BBox<S, V>

👎 Deprecated:

Use from_corners instead.

Constructs the smallest bounding box containing two points.

pub fn from_corners(p0: Point<S, V>, p1: Point<S, V>) -> BBox<S, V>

Constructs the smallest bounding box containing two points.

Example

let p0 = p2d(2, 3);
let p1 = p2d(-1, 4);
assert_eq!(bb2d(-1..3, 3..5), BBox2d::from_corners(p0, p1));

pub fn enclosing<'a, II>(ii: II) -> Option<BBox<S, V>> where
    S: 'a,
    V: 'a,
    II: IntoIterator<Item = &'a Point<S, V>>, 

Constructs the minimal bounding box containing points from an iterator, or None if the iterator is empty.

Example

let points = vec![p2d(2, 3), p2d(-1, 4), p2d(1, 0)];
assert_eq!(Some(bb2d(-1..=2, 0..=4)), BBox2d::enclosing(&points));

pub fn min(&self) -> Point<S, V>

The minimal point in the bounding box.

Example

let b = bb2d(-1..3, 3..5);
assert_eq!(p2d(-1, 3), b.min());

pub fn max(&self) -> Point<S, V>

The maximal point in the bounding box.

Example

let b = bb2d(-1..3, 3..5);
assert_eq!(p2d(2, 4), b.max());

pub fn lengths(&self) -> V

Returns a vector of the lengths for the coordinates.

Example

let b = bb2d(-1..3, 3..5);
assert_eq!(p2d(2, 4), b.max());

pub fn volume(&self) -> usize where
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

Returns the volume of the bounding box.

Example

let b = bb2d(-1..3, 3..5);
assert_eq!(8, b.volume());

pub fn center(&self) -> Point<S, V>

The center point in the bounding box.

This is only the true center of the bounding box if the bounding box has odd dimensions. Otherwise the coordinates of the center are rounded according to the rules for integer division, i.e. towards zero.

Example

let b = bb2d(-1..4, 3..6);
assert_eq!(p2d(1, 4), b.center());

pub fn lub(&self, other: &BBox<S, V>) -> BBox<S, V>

The least upper bound of two bounding boxes w.r.t. inclusion.

That is, the smallest bounding box encompassing the points in the two boxes.

Example

let bb0 = bb2d(-2..3, -1..2);
let bb1 = bb2d(-5..4, 2..5);
assert_eq!(bb2d(-5..4, -1..5), bb0.lub(&bb1));

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

The intersection of two bounding boxes, or None if they don’t intersect.

Example

let bb0 = bb2d(-2..=3, -1..=2);
let bb1 = bb2d(-5..=4, 0..=5);
assert_eq!(Some(bb2d(-2..=3, 0..=2)), bb0.intersection(&bb1));

pub fn extend_to(&self, p: Point<S, V>) -> BBox<S, V>

Returns the smallest bounding box encompassing this box and a given point.

Example

let bb = bb2d(-2..3, -1..2);
let p = p2d(3, 4);
assert_eq!(bb2d(-2..4, -1..5), bb.extend_to(p));

pub fn clamp(&self, p: Point<S, V>) -> Point<S, V>

Returns the closest point inside the bounding box for a given point.

If the point is inside the bounding box it is returned unchanged. Otherwise the coordinates that fall outside the ranges of the box are clamped to the closest endpoints of the ranges.

Example

let b = bb2d(-1..4, 3..6);
assert_eq!(p2d(3, 4), b.clamp(p2d(10, 4)));

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

Returns true if the point is inside the bounding box.

Example

let b = bb2d(-1..4, 3..6);
assert!(b.contains(&p2d(0, 4)));
assert!(!b.contains(&p2d(10, 4)));

impl<S> BBox<S, Vec2d<S>> where
    S: Integer, 

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

👎 Deprecated:

Use bb2d instead.

Constructs a bounding box from bounds.

As always, lower bbox are inclusive, upper bbox 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 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 x_len(&self) -> S

Returns the width of the bounding box.

pub fn y_len(&self) -> S

Returns the height of the bounding box.

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

Returns the area of 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) -> Points<S, Vec2d<S>, Layout2d<S>> where
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

Returns an iterator over the points in the bounding box.

Points are returned by row.

impl<S> BBox<S, Vec3d<S>> where
    S: Integer, 

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 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 z_start(&self) -> S

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

pub fn z_end(&self) -> S

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

pub fn z_min(&self) -> S

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

pub fn z_max(&self) -> S

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

pub fn x_len(&self) -> S

Returns the size of the x-dimension of the bounding box.

pub fn y_len(&self) -> S

Returns the size of the y-dimension of the bounding box.

pub fn z_len(&self) -> S

Returns the size of the z-dimension of the bounding box.

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

Returns the range of the x coordinate.

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

Returns the range of the y coordinate.

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

Returns the range of the z coordinate.

pub fn iter(&self) -> Points<S, Vec3d<S>, Layout3d<S>> where
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

Returns an iterator over the points in the bounding box.

Points are returned by row.

impl<S> BBox<S, Vec4d<S>> where
    S: Integer, 

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 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 z_start(&self) -> S

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

pub fn z_end(&self) -> S

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

pub fn z_min(&self) -> S

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

pub fn z_max(&self) -> S

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

pub fn w_start(&self) -> S

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

pub fn w_end(&self) -> S

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

pub fn w_min(&self) -> S

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

pub fn w_max(&self) -> S

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

pub fn x_len(&self) -> S

Returns the size of the x-dimension of the bounding box.

pub fn y_len(&self) -> S

Returns the size of the y-dimension of the bounding box.

pub fn z_len(&self) -> S

Returns the size of the z-dimension of the bounding box.

pub fn w_len(&self) -> S

Returns the size of the w-dimension of the bounding box.

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

Returns the range of the x coordinate.

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

Returns the range of the y coordinate.

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

Returns the range of the z coordinate.

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

Returns the range of the w coordinate.

pub fn iter(&self) -> Points<S, Vec4d<S>, Layout4d<S>> where
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

Returns an iterator over the points in the bounding box.

Points are returned by row.

Trait Implementations

impl<S: Clone + Integer, V: Clone + Vector<S>> Clone for BBox<S, V>

fn clone(&self) -> BBox<S, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Integer, V: Debug + Vector<S>> Debug for BBox<S, V>

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

Formats the value using the given formatter.

impl<S: Hash + Integer, V: Hash + Vector<S>> Hash for BBox<S, V>

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<S> IntoIterator for BBox<S, Vec2d<S>> where
    S: Integer,
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

type Item = Point2d<S>

The type of the elements being iterated over.

type IntoIter = Points<S, Vec2d<S>, Layout2d<S>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S> IntoIterator for &'a BBox<S, Vec2d<S>> where
    S: Integer,
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

type Item = Point2d<S>

The type of the elements being iterated over.

type IntoIter = Points<S, Vec2d<S>, Layout2d<S>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S> IntoIterator for BBox<S, Vec3d<S>> where
    S: Integer,
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

type Item = Point3d<S>

The type of the elements being iterated over.

type IntoIter = Points<S, Vec3d<S>, Layout3d<S>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S> IntoIterator for &'a BBox<S, Vec3d<S>> where
    S: Integer,
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

type Item = Point3d<S>

The type of the elements being iterated over.

type IntoIter = Points<S, Vec3d<S>, Layout3d<S>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S> IntoIterator for BBox<S, Vec4d<S>> where
    S: Integer,
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

type Item = Point4d<S>

The type of the elements being iterated over.

type IntoIter = Points<S, Vec4d<S>, Layout4d<S>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S> IntoIterator for &'a BBox<S, Vec4d<S>> where
    S: Integer,
    usize: TryFrom<S>,
    <usize as TryFrom<S>>::Error: Debug, 

type Item = Point4d<S>

The type of the elements being iterated over.

type IntoIter = Points<S, Vec4d<S>, Layout4d<S>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S: PartialEq + Integer, V: PartialEq + Vector<S>> PartialEq<BBox<S, V>> for BBox<S, V>

fn eq(&self, other: &BBox<S, V>) -> bool

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

fn ne(&self, other: &BBox<S, V>) -> bool

This method tests for !=.

impl<S: Copy + Integer, V: Copy + Vector<S>> Copy for BBox<S, V>

impl<S: Eq + Integer, V: Eq + Vector<S>> Eq for BBox<S, V>

impl<S: Integer, V: Vector<S>> StructuralEq for BBox<S, V>

impl<S: Integer, V: Vector<S>> StructuralPartialEq for BBox<S, V>