Struct nannou::geom::cuboid::Cuboid

pub struct Cuboid<S = DefaultScalar> {
    pub x: Range<S>,
    pub y: Range<S>,
    pub z: Range<S>,
}

A light-weight Cuboid type with many helper and utility methods.

The cuboid is also known as a "rectangular prism".

Cuboid is implemented similarly to geom::Rect but with 3 axes instead of 2.

Fields

x: Range<S>

The start and end along the x axis.

y: Range<S>

The start and end along the y axis.

z: Range<S>

The start and end along the z axis.

Methods

impl<S> Cuboid<S> where
    S: BaseNum, 

pub fn from_xyz_whd(p: Point3<S>, d: Vector3<S>) -> Self

Construct a Rect from a given centre point (x, y, z) and dimensions (width, height, depth).

pub fn from_ranges(x: Range<S>, y: Range<S>, z: Range<S>) -> Self

Construct a cuboid from its x, y and z ranges.

pub fn absolute(&self) -> Self

Converts self to an absolute Cuboid so that the magnitude of each range is always positive.

pub fn x(&self) -> S

The position in the middle of the x range.

pub fn y(&self) -> S

The position in the middle of the y range.

pub fn z(&self) -> S

The position in the middle of the z range.

pub fn xyz(&self) -> Point3<S>

The xyz position in the middle of the bounds.

pub fn x_y_z(&self) -> (S, S, S)

The centered x, y and z coordinates as a tuple.

pub fn shift_x(self, x: S) -> Self

Shift the cuboid along the x axis.

pub fn shift_y(self, y: S) -> Self

Shift the cuboid along the y axis.

pub fn shift_z(self, z: S) -> Self

Shift the cuboid along the z axis.

pub fn shift(self, v: Vector3<S>) -> Self

Shift the cuboid by the given vector.

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

Does the given cuboid contain the given point.

pub fn stretch_to_point(self, p: Point3<S>) -> Self

Stretches the closest side(s) to the given point if the point lies outside of the Cuboid area.

pub fn overlap(self, other: Self) -> Option<Self>

The cuboid representing the area in which two cuboids overlap.

pub fn max(self, other: Self) -> Self where
    S: Float, 

The cuboid that encompass the two given cuboids.

pub fn left(&self) -> S

The start of the range along the x axis.

pub fn right(&self) -> S

The end of the range along the x axis.

pub fn bottom(&self) -> S

The start of the range along the y axis.

pub fn top(&self) -> S

The end of the range along the y axis.

pub fn front(&self) -> S

The start of the range along the z axis.

pub fn back(&self) -> S

The end of the range along the z axis.

pub fn left_quad(&self) -> FaceQuad<S>

The quad for the face at the start of the range along the x axis.

pub fn right_quad(&self) -> FaceQuad<S>

The quad for the face at the end of the range along the x axis.

pub fn bottom_quad(&self) -> FaceQuad<S>

The quad for the face at the start of the range along the y axis.

pub fn top_quad(&self) -> FaceQuad<S>

The quad for the face at the end of the range along the y axis.

pub fn front_quad(&self) -> FaceQuad<S>

The quad for the face at the start of the range along the z axis.

pub fn back_quad(&self) -> FaceQuad<S>

The quad for the face at the end of the range along the z axis.

pub fn face_quad(&self, face: Face) -> FaceQuad<S>

The quad for the given face.

pub fn corners(&self) -> [Point3<S>; 8]

The 8 corners of the cuboid in the following order:

y
| z
|/
0---x

  6---7
 /|  /|
2---3 |
| 4-|-5
|/  |/ 
0---1

Important traits for Corners<'a, S>

impl<'a, S> Iterator for Corners<'a, S> where
    S: Copy,  type Item = Point3<S>;

pub fn corners_iter(&self) -> Corners<S>

The same as corners but produces an iterator rather than a fixed-size array.

pub fn faces(&self) -> [FaceQuad<S>; 6]

The 6 faces of the of the cuboid in the order yielded by the Faces iterator.

Important traits for FaceQuads<'a, S>

impl<'a, S> Iterator for FaceQuads<'a, S> where
    S: BaseNum,  type Item = FaceQuad<S>;

pub fn faces_iter(&self) -> FaceQuads<S>

An iterator yielding a quad for each face on the cuboid.

Important traits for Triangles<'a, S>

impl<'a, S> Iterator for Triangles<'a, S> where
    S: BaseNum,  type Item = Tri<Point3<S>>;

pub fn triangles_iter(&self) -> Triangles<S>

Produce an iterator yielding every triangle in the cuboid (two for each face).

Uses the faces_iter method internally.

pub fn subdivision_ranges(&self) -> SubdivisionRanges<S>

The six ranges used for the Cuboid's eight subdivisions.

impl<S> Cuboid<S> where
    S: BaseNum + Neg<Output = S>, 

pub fn w(&self) -> S

The length of the cuboid along the x axis (aka width or w for short).

pub fn h(&self) -> S

The length of the cuboid along the y axis (aka height or h for short).

pub fn d(&self) -> S

The length of the cuboid along the z axis (aka depth or d for short).

pub fn whd(&self) -> Vector3<S>

The dimensions (width, height and depth) of the cuboid as a vector.

pub fn w_h_d(&self) -> (S, S, S)

The dimensions (width, height and depth) of the cuboid as a tuple.

pub fn volume(&self) -> S

The total volume of the cuboid.

pub fn xyz_whd(&self) -> (Point3<S>, Vector3<S>)

The position and dimensions of the cuboid.

pub fn x_y_z_w_h_d(&self) -> (S, S, S, S, S, S)

The position and dimensions of the cuboid.

pub fn pad_left(self, pad: S) -> Self

The cuboid with some padding applied to the left side.

pub fn pad_right(self, pad: S) -> Self

The cuboid with some padding applied to the right side.

pub fn pad_bottom(self, pad: S) -> Self

The cuboid with some padding applied to the bottom side.

pub fn pad_top(self, pad: S) -> Self

The cuboid with some padding applied to the top side.

pub fn pad_front(self, pad: S) -> Self

The cuboid with some padding applied to the front side.

pub fn pad_back(self, pad: S) -> Self

The cuboid with some padding applied to the back side.

pub fn pad(self, pad: S) -> Self

The cuboid with some padding amount applied to each side.

Trait Implementations

impl<S: Copy> Copy for Cuboid<S>

impl<S: Clone> Clone for Cuboid<S>

fn clone(&self) -> Cuboid<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Cuboid<S>

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

Formats the value using the given formatter.

impl<S: PartialEq> PartialEq for Cuboid<S>

fn eq(&self, __arg_0: &Cuboid<S>) -> bool

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

fn ne(&self, __arg_0: &Cuboid<S>) -> bool

This method tests for !=.

impl<S: PartialOrd> PartialOrd for Cuboid<S>

fn partial_cmp(&self, __arg_0: &Cuboid<S>) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Cuboid<S>) -> bool

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

fn le(&self, __arg_0: &Cuboid<S>) -> bool

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

fn gt(&self, __arg_0: &Cuboid<S>) -> bool

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

fn ge(&self, __arg_0: &Cuboid<S>) -> bool

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