Struct Cuboid

Source

pub struct Cuboid { /* private fields */ }

Expand description

A cuboid (rectangular box) shape centered at the origin.

A cuboid is a three-dimensional rectangular box with six rectangular faces. It’s one of the most commonly used shapes in physics engines for representing boxes, containers, and general rectangular objects.

The cuboid is centered at the origin (0, 0, 0) with its edges aligned to the coordinate axes.

§Examples

use phys_geom::shape::Cuboid;

// Create a cuboid with dimensions 2x3x1
let cuboid = Cuboid::new([2.0, 3.0, 1.0]);
assert_eq!(cuboid.length(), [2.0, 3.0, 1.0]);
assert_eq!(cuboid.half_length(), [1.0, 1.5, 0.5]);

// Create a unit cube
let unit_cube = Cuboid::UNIT;
assert_eq!(unit_cube.length(), [1.0, 1.0, 1.0]);

§Dimensions

half_length: Half-lengths along each axis (x, y, z)
Total dimensions: [x, y, z] = [2 * half_length[0], 2 * half_length[1], 2 * half_length[2]]

§Construction

The cuboid can be constructed from:

An array of three lengths: Cuboid::new([x, y, z])
Individual components: Cuboid::new_xyz(x, y, z)

Implementations§

Source §

impl Cuboid

Source

pub const UNIT: Cuboid

A unit cube with side length 1.0.

This is useful as a reference size for normalized shapes. The cube extends from -0.5 to +0.5 along each axis.

Source

pub fn new(length: impl Into<[Real; 3]>) -> Cuboid

Creates a new cuboid with the given dimensions.

§Arguments

length - The dimensions of the cuboid as a 3-element array [x, y, z]

§Returns

A new Cuboid instance.

§Panics

Panics if any component of length is not positive.

§Examples

use phys_geom::shape::Cuboid;

// Create from array
let cuboid1 = Cuboid::new([2.0, 3.0, 1.0]);

// Create from tuple (via Into trait)
let cuboid2 = Cuboid::new((2.0, 3.0, 1.0));

assert_eq!(cuboid1.length(), cuboid2.length());

Source

pub fn new_xyz(x: Real, y: Real, z: Real) -> Cuboid

Creates a new cuboid with individual x, y, z dimensions.

This is a convenience method equivalent to Cuboid::new([x, y, z]).

§Arguments

x - Length along the X-axis
y - Length along the Y-axis
z - Length along the Z-axis

§Returns

A new Cuboid instance.

§Examples

use phys_geom::shape::Cuboid;

let cuboid = Cuboid::new_xyz(2.0, 3.0, 1.0);
assert_eq!(cuboid.length(), [2.0, 3.0, 1.0]);

Source

pub fn length(&self) -> [Real; 3]

Returns the full dimensions of the cuboid.

Returns an array [x, y, z] representing the total length along each axis.

§Returns

An array of three Real values [x, y, z].

§Examples

use phys_geom::shape::Cuboid;

let cuboid = Cuboid::new([2.0, 3.0, 1.0]);
assert_eq!(cuboid.length(), [2.0, 3.0, 1.0]);

Source

pub fn half_length(&self) -> [Real; 3]

Returns the half-lengths of the cuboid.

Returns an array [x/2, y/2, z/2] representing the distance from the center to each face along the respective axes.

§Returns

An array of three Real values [x/2, y/2, z/2].

§Examples

use phys_geom::shape::Cuboid;

let cuboid = Cuboid::new([2.0, 3.0, 1.0]);
assert_eq!(cuboid.half_length(), [1.0, 1.5, 0.5]);

Source

pub fn set_length(&mut self, length: impl Into<[Real; 3]>)

Sets the dimensions of the cuboid.

§Arguments

length - The new dimensions as a 3-element array [x, y, z]

§Panics

Panics if any component of length is not positive.

§Examples

use phys_geom::shape::Cuboid;

let mut cuboid = Cuboid::new([1.0, 1.0, 1.0]);
cuboid.set_length([2.0, 3.0, 1.0]);
assert_eq!(cuboid.length(), [2.0, 3.0, 1.0]);