Struct glamour::Box3

#[repr(C)]
pub struct Box3<T: Unit = f32> {
    pub min: Point3<T>,
    pub max: Point3<T>,
}

3D axis-aligned box.

Fields

min: Point3<T>

Lower bound of the box.

max: Point3<T>

Upper bound of the box.

Implementations

impl<T: Unit> Box3<T>

pub const ZERO: Self = _

Zero-sized box.

pub fn new(min: impl Into<Point3<T>>, max: impl Into<Point3<T>>) -> Self

New 2D box from min/max coordinates.

pub fn from_untyped(untyped: Box3<T::Scalar>) -> Box3<T>

Bitcast an untyped instance to self.

pub fn to_untyped(self) -> Box3<T::Scalar>

Bitcast self to an untyped instance.

pub fn as_untyped(&self) -> &Box3<T::Scalar>

Reinterpret cast self as the untyped variant.

pub fn as_untyped_mut(&mut self) -> &mut Box3<T::Scalar>

Reinterpret cast self as the untyped variant.

pub fn cast<T2>(self) -> Box3<T2>

where T2: Unit<Scalar = T::Scalar>,

Cast to a different coordinate space with the same underlying scalar type.

pub fn cast_ref<T2>(&self) -> &Box3<T2>

where T2: Unit<Scalar = T::Scalar>,

Cast to a different coordinate space with the same underlying scalar type.

pub fn cast_mut<T2>(&mut self) -> &mut Box3<T2>

where T2: Unit<Scalar = T::Scalar>,

Cast to a different coordinate space with the same underlying scalar type.

pub fn try_cast<T2>(self) -> Option<Box3<T2>>

where T2: Unit,

Cast to a different coordinate space with scalar type conversion. Returns None if any component could not be converted to the target scalar type.

pub const fn from_tuple((min, max): (Point3<T>, Point3<T>)) -> Self

Instantiate from tuple.

pub const fn to_tuple(self) -> (Point3<T>, Point3<T>)

Convert to tuple.

impl<T> Box3<T>

where T: Unit, T::Scalar: FloatScalar,

pub fn round(self) -> Self

Round coordinates to the nearest integer.

Note: This function makes no attempt to avoid creating “degenerate” boxes, where min >= max.

Example

let b = Box3::<f32>::new((0.3, 0.3, 0.3), (2.7, 2.7, 2.7));
let rounded = b.round();
assert_eq!(rounded.min, (0.0, 0.0, 0.0));
assert_eq!(rounded.max, (3.0, 3.0, 3.0));

pub fn round_in(self) -> Self

Round towards from the center of the box.

Note: This function makes no attempt to avoid creating “degenerate” boxes, where min >= max.

Example

let b = Box3::<f32>::new((0.3, 0.3, 0.3), (2.7, 2.7, 2.7));
let rounded = b.round_in();
assert_eq!(rounded.min, (1.0, 1.0, 1.0));
assert_eq!(rounded.max, (2.0, 2.0, 2.0));

pub fn round_out(self) -> Self

Round away from the center of the box.

Note: This function can only create “degenerate” boxes (where min >= max) if the box was already degenerate.

Example

let b = Box3::<f32>::new((0.7, 0.7, 0.7), (1.4, 1.4, 1.4));
let rounded = b.round_out();
assert_eq!(rounded.min, (0.0, 0.0, 0.0));
assert_eq!(rounded.max, (2.0, 2.0, 2.0));

pub fn lerp(self, other: Self, t: T::Scalar) -> Self

Linear interpolation between boxes.

Trait Implementations

impl<T: Unit> AbsDiffEq for Box3<T>

type Epsilon = <<T as Unit>::Scalar as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Self, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Unit> Clone for Box3<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Unit> Debug for Box3<T>

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

Formats the value using the given formatter.

impl<T: Unit> Default for Box3<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Unit> From<(Point3<T>, Point3<T>)> for Box3<T>

fn from(tuple: (Point3<T>, Point3<T>)) -> Box3<T>

Converts to this type from the input type.

impl<T: Unit> From<Box3<T>> for (Point3<T>, Point3<T>)

fn from(value: Box3<T>) -> (Point3<T>, Point3<T>)

Converts to this type from the input type.

impl<T> Hash for Box3<T>

where T: Unit, T::Scalar: Hash,

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Unit> PartialEq<(Point3<T>, Point3<T>)> for Box3<T>

fn eq(&self, (min, max): &(Point3<T>, Point3<T>)) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Unit> PartialEq for Box3<T>

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Unit> RelativeEq for Box3<T>

where T::Scalar: RelativeEq,

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T: Unit> UlpsEq for Box3<T>

where T::Scalar: UlpsEq,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T: Unit> Zeroable for Box3<T>

SAFETY: All members are Pod, and we are #[repr(C)].

fn zeroed() -> Self

Calls zeroed.

impl<T: Unit> Copy for Box3<T>

impl<T> Eq for Box3<T>

where T: Unit, T::Scalar: Eq,

impl<T: Unit> Pod for Box3<T>

SAFETY: All members are Pod, and we are #[repr(C)].