# marching-cubes-faster

> CSG-like version of `marching-cubes-fast`, very fast marching cubes mesher

Latest version **0.0.151** (published 2023-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install marching-cubes-faster
pnpm add marching-cubes-faster
yarn add marching-cubes-faster
bun add marching-cubes-faster
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.151 |
| Published | 2023-10-27 |
| First published | 2022-04-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 58.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | stonkpunk |
| Maintainers | stonkpunk |
| Keywords | marching, cubes, sparse, fast, isosurface, signed, distance, octree, voxels, hausdorff, LOD, CSG |

## Links

- npm: https://www.npmjs.com/package/marching-cubes-faster
- Homepage: https://github.com/stonkpunk/my-npm-modules/tree/main/marching-cubes-faster
- npm.io page: https://npm.io/package/marching-cubes-faster

## Dependencies (4)

- [rbush-3d](https://npm.io/package/rbush-3d.md) 0.0.4
- [triangle-distance](https://npm.io/package/triangle-distance.md) ^1.0.11
- [round-cone-distance](https://npm.io/package/round-cone-distance.md) ^1.0.11
- [tetrahedron-distance](https://npm.io/package/tetrahedron-distance.md) 0.0.21

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.0.151 (latest) — 2023-10-27
- 0.0.15 — 2022-04-13
- 0.0.14 — 2022-04-10
- 0.0.13 — 2022-04-10
- 0.0.12 — 2022-04-10
- 0.0.11 — 2022-04-10
- 0.0.1 — 2022-04-10

## README

# marching-cubes-faster

Even faster [but less generic] version of `marching-cubes-fast` that allows you to build distance functions using CSG-like primitives.

Internally, the primitives are organized by an R-tree via `rbush-3d`. 

Similar to `marching-cubes-fast`, this tool efficiently generates a list of surface cells with an octree-like recursive structure. As that happens, this tool queries the R-tree to associate each leaf cell with only the primitives potentially affecting it. Finally the kernel is run on the leaves.

In practice this means the kernel is only dealing with 1 or 2 primitives at a time for the vast majority of surface cells, and the runtime is roughly proportional to surface area [eg the final number of cells]. 

## Installation

```sh
npm i marching-cubes-faster
```

## Usage 

```javascript
var mfc = require('marching-cubes-faster');
var mb = mfc.meshBuilder;
var dfb = mfc.dfBuilder;

var t0=Date.now();
var theList = [];

for(var i=0; i<1000; i++){
    var radius = 8;
    //functions for adding shapes
    //dfb.addBrick(theList, dfb.randomBrick(), radius); //add an aabb [[x,y,z],[x,y,z]] with radius padding
    //dfb.addTriangle(theList, dfb.randomTriangle(), radius); //add a triangle [[x,y,z],[x,y,z],[x,y,z]] with radius padding [thickness]
    //dfb.addTetra(theList, dfb.randomTetrahedron(), radius); //add a tetrahedron [[x,y,z],[x,y,z],[x,y,z],[x,y,z]] with radius padding
    dfb.addLine(theList, dfb.randomLine(), radius); //add a line segment [[x,y,z],[x,y,z]] with radius thickness
    //dfb.addLineCone(theList, dfb.randomLineCone()); //add a line segment with different end radii r0 and r1 {line:[[x,y,z],[x,y,z]], r0, r1}

    //similar functions for subtracting shapes
    //dfb.subtractBrick(theList, dfb.randomBrick(), radius);
    //dfb.subtractTriangle(theList, dfb.randomTriangle(), radius);
    //dfb.subtractTetra(theList, dfb.randomTetrahedron(), radius);
    //dfb.subtractLine(theList, dfb.randomLine(), radius);
    //dfb.subtractLineCone(theList, dfb.randomLineCone(), radius);
}

var iters = 6; //how many times to subdivide the octree. increasing by 1 will double the number of triangles in the result.
var result = mb.buildForList(theList,iters); //{cells, positions, dfBuilderResult} //dfBuilderResult contains {rtree, rTreeObjs}

//note - by default, the function meshes the bounding box of the entire set of primitives

//if you want to build only an arbitrary bounding box:
//var result = mb.buildForList(theList, iters, boundingBox); //boundingBox = [[x,y,z],[x,y,z]]

//full params:
//buildForList(dfObjList, iters=5, renderBlock = dfListBounds(dfObjList), _dfBuilderResult?)
//set _dfBuilderResult if you want to re-use an rtree from a previous call
```

![lines](https://i.imgur.com/UcdSbk6.png)

^ result as rendered with `ascii-raytracer` [see test.js]

## See Also

- [marching-cubes-fast](https://www.npmjs.com/package/marching-cubes-fast) 
- [sdf-csg](https://www.npmjs.com/package/sdf-csg) - similar tool


[![stonks](https://i.imgur.com/UpDxbfe.png)](https://www.npmjs.com/~stonkpunk)

---
_Source: https://npm.io/package/marching-cubes-faster · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._