Struct building_blocks_core::extent::ExtentN

pub struct ExtentN<N> {
    pub minimum: PointN<N>,
    pub shape: PointN<N>,
}

An N-dimensional extent. This is mathematically the Cartesian product of a half-closed interval [a, b) in each dimension. You can also just think of it as an axis-aligned box with some shape and a minimum point. When doing queries against lattice maps, this is the primary structure used to determine the bounds of your query.

Fields

minimum: PointN<N>

The least point contained in the extent.

shape: PointN<N>

The length of each dimension.

Implementations

impl<N> ExtentN<N>

pub fn from_min_and_shape(minimum: PointN<N>, shape: PointN<N>) -> Self

The default representation of an extent as the minimum point and shape.

impl<N> ExtentN<N> where
    PointN<N>: Point, 

pub fn volume(&self) -> <PointN<N> as Point>::Scalar

pub fn with_minimum(&self, new_min: PointN<N>) -> Self

Translate the extent such that it has new_min as it’s new minimum.

pub fn least_upper_bound(&self) -> PointN<N>

The least point p for which all points q in the extent satisfy q < p.

pub fn contains(&self, p: PointN<N>) -> bool

Returns true iff the point p is contained in this extent.

pub fn add_to_shape(&self, delta: PointN<N>) -> Self

Resize the extent by mutating its shape by delta.

pub fn padded(&self, pad_amount: <PointN<N> as Point>::Scalar) -> Self where
    <PointN<N> as Point>::Scalar: Add<Output = <PointN<N> as Point>::Scalar>, 

Returns a new extent that’s been padded on all borders by pad_amount.

impl<N> ExtentN<N> where
    PointN<N>: IntegerPoint<N>, 

pub fn num_points(&self) -> usize

The number of points contained in the extent.

pub fn is_empty(&self) -> bool

Returns true iff the number of points in the extent is 0.

pub fn from_min_and_lub(
    minimum: PointN<N>,
    least_upper_bound: PointN<N>
) -> Self

An alternative representation of an extent as the minimum point and least upper bound.

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

Returns the extent containing only the points in both self and other.

pub fn is_subset_of(&self, other: &Self) -> bool

Returns true iff the intersection of self and other is equal to self.

pub fn from_min_and_max(minimum: PointN<N>, max: PointN<N>) -> Self

An alternative representation of an integer extent as the minimum point and maximum point. This only works for integer extents, where there is a unique maximum point.

pub fn max(&self) -> PointN<N>

The unique greatest point in the extent.

pub fn from_corners(p1: PointN<N>, p2: PointN<N>) -> Self

Constructs the unique extent with both p1 and p2 as corners.

pub fn iter_points(&self) -> <PointN<N> as IterExtent<N>>::PointIter

Iterate over all points in the extent.

let extent = Extent3i::from_min_and_shape(PointN([0, 0, 0]), PointN([2, 2, 1]));
let points = extent.iter_points().collect::<Vec<_>>();
assert_eq!(points, vec![
    PointN([0, 0, 0]), PointN([1, 0, 0]), PointN([0, 1, 0]), PointN([1, 1, 0])
]);

Trait Implementations

impl<T> Add<PointN<T>> for ExtentN<T> where
    PointN<T>: Add<Output = PointN<T>>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: PointN<T>) -> Self::Output

Performs the + operation.

impl<T> AddAssign<PointN<T>> for ExtentN<T> where
    Self: Copy + Add<PointN<T>, Output = ExtentN<T>>, 

fn add_assign(&mut self, rhs: PointN<T>)

Performs the += operation.

impl<N> Clone for ExtentN<N> where
    PointN<N>: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for ExtentN<N>

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

Formats the value using the given formatter.

impl<'de, N> Deserialize<'de> for ExtentN<N> where
    N: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Mul<PointN<T>> for ExtentN<T> where
    PointN<T>: Copy + Mul<Output = PointN<T>>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: PointN<T>) -> Self::Output

Performs the * operation.

impl<N> PartialEq<ExtentN<N>> for ExtentN<N> where
    PointN<N>: PartialEq, 

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

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

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

This method tests for !=.

impl<N> Serialize for ExtentN<N> where
    N: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T> Sub<PointN<T>> for ExtentN<T> where
    PointN<T>: Sub<Output = PointN<T>>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: PointN<T>) -> Self::Output

Performs the - operation.

impl<T> SubAssign<PointN<T>> for ExtentN<T> where
    Self: Copy + Sub<PointN<T>, Output = ExtentN<T>>, 

fn sub_assign(&mut self, rhs: PointN<T>)

Performs the -= operation.

impl<N> Copy for ExtentN<N> where
    PointN<N>: Copy, 

impl<N: Eq> Eq for ExtentN<N>

impl<N> StructuralEq for ExtentN<N>