The complete reference for the Bitbybit 3D CAD API - every class, method, input type and enum,
generated from the shipped TypeScript declarations so it never drifts from the code.
Explore 1400+ functions across OCCT, JSCAD, Manifold and more.
Scaffold a fully configured 3D CAD project in seconds. The CLI sets up Vite, TypeScript
and all three geometry kernels - OCCT, JSCAD and Manifold - with starter code for the
engine you pick. The same packages run in Node.js, and the -worker variants
keep the WASM kernels off the browser's main thread.
npx @bitbybit-dev/create-app my-project
Each category is a property of the bitbybit object in your code, so
bitbybit.occt.shapes is the occt card and then its shapes class.
Use this site when you need the exact signature, parameter DTO or return type of a call;
for walkthroughs and worked examples go to learn.bitbybit.dev.
Render any geometry - points, lines, meshes, kernel shapes, tags - into the scene, then update or dispose what came back.
BabylonJS engine features: scene, cameras, lights, materials, textures, picking, gizmos, glTF and XR.
2D and 3D vector arithmetic: add, subtract, scale, dot and cross products, normalise, angle and interpolation.
Points in 2D and 3D, singly or in grids, spirals and hexagonal sets; measure, sort and transform them.
Straight segments from start and end points: create in bulk, measure, reverse, transform and convert to kernel edges.
Connected line sequences, open or closed - the simplest outline before it becomes a face or a solid.
Polygonal mesh geometry - triangles, vertices, normals - and conversion between the representations the kernels use.
The OpenCascade solid modelling kernel: exact BREP booleans, fillets, lofts, sweeps, offsets, shelling, STEP and IGES.
Higher-level tools on top of the kernels: dimension annotations, camera navigation, surface patterning and 3D text. Available in the bitbybit.dev editors.
Finished parametric models - furniture, vases, boxes, birdhouses - each exposing the parameters that shape it. Available in the bitbybit.dev editors.
The JSCAD constructive solid geometry kernel: primitives combined with booleans, expansions, hulls and extrusions.
The Manifold kernel: fast, reliably watertight mesh booleans, plus 2D cross sections and their extrusion.
Comparisons, and/or/not, conditional selection and value gates that let a model react to its parameters.
Trigonometry, rounding, clamping, remapping between ranges, interpolation and seeded randomness.
Array operations: create, slice, flatten, reverse, sort, group, zip, repeat and pick - what sits between two geometry calls.
Colours across hex, RGB and HSL, with blending, inversion and colour ranges for draw options and materials.
String utilities: join, split, replace, trim, case conversion, padding and formatting.
Date and time values: create, parse, format, compare and do arithmetic on them.
Parse, stringify, query and edit JSON - the usual way to bring configuration in and hand results out.
Read and write CSV: drive a model from a spreadsheet of parameters, or export a cutting list back out.
NURBS curves and surfaces: interpolated curves, lofted and swept surfaces, intersections and closest-point queries.
Text labels positioned in 3D space that stay readable as the camera moves - dimensions, part numbers, annotations.
Per-frame callbacks and the timing values that turn a static model into an animated one.
Load 3D models, textures, fonts and data files from the project's asset store or a URL, ready for the kernels or the renderer.
Everything lives under the root Bit namespace, split into three kinds of entry.
OCCT, JSCAD, Manifold, Vector, Draw,
Babylon and their sub-classes carry the methods you call. A class such as
OCCTShapes groups the constructors for a
shape family; OCCTBooleans groups union,
difference and intersection.
Almost every method takes a single DTO argument rather than a positional list, so the DTO page is
where the defaults and units live. They sit under Bit.Inputs.*, one namespace per kernel.
Kernels deliberately repeat names - there is a CircleDto in each - so read the
namespace in the page title.
Under Bit.Models.*: the shapes returned to you,
plus the enumerations the DTOs use. The type hierarchy shows how the
types relate, and the full symbol index lists every one in one place.
The hosted platform: visual Rete and Blockly editors, a TypeScript editor and the 3D model catalogue.
Tutorials, guides and the blog - task-oriented walkthroughs and worked examples for everything documented here.
Run the same CAD kernels server-side over HTTP, with a TypeScript SDK and REST endpoints.
MIT-licensed source for every package documented here, on GitHub.
Working with an AI assistant? Point it at llms.txt for a compact index of this site, or see using AI with Bitbybit for context files and the Context7 MCP server.