solid-methods.md

Solid Developer Guide

Solid lives in src/BREP/BetterSolid.js and extends THREE.Group.

This page is now the concise developer overview for working with Solid. The canonical per-method reference lives in the Solid API index.

Use This Page For

• Understanding what Solid is responsible for in the kernel.
• Learning the main authoring and boolean workflow.
• Jumping to the right detailed method page quickly.

Canonical API Docs

• Solid API index
• Face API index
• Edge API index

Mental Model

• Solid stores authored triangle geometry in flat arrays plus face-label mappings.
• _manifoldize() turns authored arrays into a cached Manifold object for booleans, measurements, and export.
• visualize() builds Face and Edge objects for selection, PMI, and UI inspection.
• Face labels are semantic names attached per triangle and preserved through reconstruction and boolean operations.

Common Workflows

Author a solid manually

Use:

• constructor()
• addTriangle()
• setFaceMetadata()
• setEpsilon()

import { Solid } from '../src/BREP/BetterSolid.js';

const solid = new Solid();
solid.addTriangle('TOP', [0, 0, 1], [1, 0, 1], [0, 1, 1]);

Transform or inspect a solid

Use:

• bakeTransform()
• bakeTRS()
• getFace()
• getFaces()
• getBoundaryEdgePolylines()
• volume()
• surfaceArea()

Clean up authored or booleaned geometry

Use:

• fixTriangleWindingsByAdjacency()
• removeTinyBoundaryTriangles()
• collapseTinyTriangles()
• removeInternalTriangles()
• cleanupTinyFaceIslands()
• mergeTinyFaces()

Run booleans or feature builders

Use:

• union()
• subtract()
• intersect()
• difference()
• chamfer()
• fillet()

Export or visualize

Use:

• visualize()
• toSTL()
• writeSTL()
• toSTEP()
• writeSTEP()

Related Pages

• Kernel and Geometry Docs
• BREP Class API Reference
• BREP Kernel Reference
• BREP.js Export Map and Usage
• BREP Model and Classes