Struct Box3

pub struct Box3 {
    pub origin: Point3,
    pub x: Vec3,
    pub y: Vec3,
    pub z: Vec3,
}

An oriented box: the generalization of a rectangle to three dimensions.

Distinct from Aabb, which is axis-aligned and exists for broad-phase rejection. This one carries its own orientation, so it can bound a rotated object tightly where an axis-aligned box would not.

The three edge vectors are not required to be mutually perpendicular, for the same reason Rectangle3 does not require it: a dirty import stays representable and inspectable.

Fields

origin: Point3

Corner the edge vectors start from.

x: Vec3

First edge vector, from origin.

y: Vec3

Second edge vector, from origin.

z: Vec3

Third edge vector, from origin.

Implementations

impl Box3

pub const fn new(origin: Point3, x: Vec3, y: Vec3, z: Vec3) -> Self

Construct from a corner and three edge vectors.

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

The eight corners.

Ordered so bit 0 selects x, bit 1 selects y, and bit 2 selects z: index 0 is origin and index 7 is the far corner. That ordering lets a caller index a corner by axis mask instead of memorising a winding.

pub fn signed_volume(&self) -> Scalar

Signed volume. Negative when the edge vectors are left-handed.

Signed rather than absolute so a caller can detect an inverted frame, which is a common symptom of a mirrored or badly converted import.

pub fn center(&self) -> Point3

Centre point.

Trait Implementations

impl Clone for Box3

fn clone(&self) -> Box3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Box3

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

Formats the value using the given formatter.

impl PartialEq for Box3

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Box3

impl StructuralPartialEq for Box3