Cuboid

Overview

The Cuboid class creates 3D rectangular box shapes (also known as rectangular prisms or boxes). Cuboids are defined by their center point and dimensions along the X, Y, and Z axes.

Constructor

const cuboid = new Cuboid(options?: ICuboidOptions);

ICuboidOptions

ogid

string

Unique identifier for the cuboid. Auto-generated if not provided.

center

Vector3

required

Center point of the cuboid in 3D space.

center: new Vector3(0, 0, 0)

width

number

required

Width of the cuboid along the X-axis.

width: 10

height

number

required

Height of the cuboid along the Y-axis.

height: 5

depth

number

required

Depth of the cuboid along the Z-axis.

depth: 8

color

number

required

Hexadecimal color value for the cuboid.

color: 0x00ff00  // Green

Methods

setConfig()

Updates the cuboid configuration and regenerates geometry.

cuboid.setConfig(options: ICuboidOptions): void

Example:

cuboid.setConfig({
  center: new Vector3(5, 2, 3),
  width: 12,
  height: 6,
  depth: 10,
  color: 0x3498db
});

getBrepData()

Returns the B-Rep (Boundary Representation) data as a parsed JSON object.

cuboid.getBrepData(): object | null

Example:

const brepData = cuboid.getBrepData();
if (brepData) {
  console.log('Vertices:', brepData.vertices);
  console.log('Edges:', brepData.edges);
  console.log('Faces:', brepData.faces);
}

generateGeometry()

Regenerates the THREE.js geometry from the current configuration. Called automatically after setConfig().

cuboid.generateGeometry(): void

discardGeometry()

Disposes of the current geometry to free memory.

cuboid.discardGeometry(): void

Properties

ogid

string

Unique identifier for the cuboid instance.

options

ICuboidOptions

Current cuboid configuration.

const currentWidth = cuboid.options.width;
const currentHeight = cuboid.options.height;
const currentDepth = cuboid.options.depth;

width

number

Get or set the cuboid width. Setting triggers geometry regeneration.

cuboid.width = 15;  // Update width and regenerate

color

number

Get or set the cuboid color.

cuboid.color = 0xff0000;  // Change to red

outline

boolean

Enable or disable outline rendering for the cuboid edges.

cuboid.outline = true;   // Show wireframe edges
cuboid.outline = false;  // Hide wireframe edges

outlineMesh

THREE.Line | null

Reference to the outline mesh if outline is enabled.

Usage Examples

Basic Cuboid

import { Cuboid, Vector3 } from 'opengeometry';

const box = new Cuboid({
  center: new Vector3(0, 0, 0),
  width: 10,
  height: 5,
  depth: 8,
  color: 0x2ecc71
});

// Add to scene
scene.add(box);

Cuboid with Outline

import { Cuboid, Vector3 } from 'opengeometry';

const cuboid = new Cuboid({
  center: new Vector3(0, 2.5, 0),
  width: 12,
  height: 5,
  depth: 6,
  color: 0x3498db
});

// Enable edge visualization
cuboid.outline = true;

Cube (Equal Dimensions)

import { Cuboid, Vector3 } from 'opengeometry';

const cube = new Cuboid({
  center: new Vector3(0, 0, 0),
  width: 8,
  height: 8,
  depth: 8,
  color: 0xe74c3c
});

Dynamic Cuboid Scaling

import { Cuboid, Vector3 } from 'opengeometry';

const cuboid = new Cuboid({
  center: new Vector3(0, 0, 0),
  width: 10,
  height: 10,
  depth: 10,
  color: 0x9b59b6
});

// Animate size
function animate() {
  const time = Date.now() * 0.001;
  const scale = 1 + Math.sin(time) * 0.3;
  
  cuboid.setConfig({
    center: cuboid.options.center,
    width: 10 * scale,
    height: 10,
    depth: 10 * scale,
    color: cuboid.options.color
  });
  
  requestAnimationFrame(animate);
}
animate();

Building Block

import { Cuboid, Vector3 } from 'opengeometry';

// Create a wall segment
const wallSegment = new Cuboid({
  center: new Vector3(0, 3, 0),
  width: 20,   // Wide
  height: 6,   // Moderate height
  depth: 1,    // Thin
  color: 0x95a5a6
});

wallSegment.outline = true;

Implementation Details

Geometry Generation

Cuboids are created by defining a rectangular base on the XZ plane and extruding it along the Y-axis using the extrude_brep_face operation. Rust Implementation: /workspace/source/main/opengeometry/src/primitives/cuboid.rs:80-129

let half_width = self.width / 2.0;
let half_height = self.height / 2.0;
let half_depth = self.depth / 2.0;

// Create bottom face vertices
bottom_face_brep.vertices.push(Vertex::new(
    0,
    Vector3::new(
        self.center.x - half_width,
        self.center.y - half_height,
        self.center.z - half_depth,
    ),
));
// ... (additional vertices)

// Extrude to create the box
let extruded_brep = extrude_brep_face(bottom_face_brep, self.height);

Material Configuration

Cuboids use MeshStandardMaterial with transparency: Source: /workspace/source/main/opengeometry/src/shapes/cuboid.ts:100-104

const material = new THREE.MeshStandardMaterial({
  color: this.options.color,
  transparent: true,
  opacity: 0.6,
});

B-Rep Structure

Cuboids have a well-defined B-Rep structure:

8 vertices (corners)
12 edges (connecting corners)
6 faces (sides)

Source: /workspace/source/main/opengeometry/src/primitives/cuboid.rs:86-128

Best Practices

Center-Based Positioning: Cuboids are positioned by their center point, making rotation and scaling operations more intuitive.

Non-Zero Dimensions: All dimensions (width, height, depth) should be greater than zero. Zero or negative values may cause rendering issues.

Memory Management: Use discardGeometry() when removing cuboids from the scene to properly free GPU memory.

Live Demo

Cuboid Demo

Try the Cuboid shape in the browser

Wedge

Triangular prism shapes

Cylinder

Cylindrical shapes

Polygon

2D base shapes

2D Primitives

3D Shapes

Operations

Export (Experimental)

Overview

Constructor

ICuboidOptions

Methods

setConfig()

getBrepData()

generateGeometry()

discardGeometry()

Properties

Usage Examples

Basic Cuboid

Cuboid with Outline

Cube (Equal Dimensions)

Dynamic Cuboid Scaling

Building Block

Implementation Details

Geometry Generation

Material Configuration

B-Rep Structure

Best Practices

Live Demo

Cuboid Demo

See Also

Wedge

Cylinder

Polygon

​Overview

​Constructor

​ICuboidOptions

​Methods

​setConfig()

​getBrepData()

​generateGeometry()

​discardGeometry()

​Properties

​Usage Examples

​Basic Cuboid

​Cuboid with Outline

​Cube (Equal Dimensions)

​Dynamic Cuboid Scaling

​Building Block

​Implementation Details

​Geometry Generation

​Material Configuration

​B-Rep Structure

​Best Practices

​Live Demo

Cuboid Demo

​See Also

Wedge

Cylinder

Polygon

Overview

Constructor

ICuboidOptions

Methods

setConfig()

getBrepData()

generateGeometry()

discardGeometry()

Properties

Usage Examples

Basic Cuboid

Cuboid with Outline

Cube (Equal Dimensions)

Dynamic Cuboid Scaling

Building Block

Implementation Details

Geometry Generation

Material Configuration

B-Rep Structure

Best Practices

Live Demo

See Also