# gl-isosurface3d

> 3D isosurface generator

Latest version **0.5.0** (published 2018-07-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install gl-isosurface3d
pnpm add gl-isosurface3d
yarn add gl-isosurface3d
bun add gl-isosurface3d
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2018-07-18 |
| First published | 2018-07-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 31.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Mikola Lysenko, Ilmari Heikkinen |
| Maintainers | ilmarihei |
| Keywords | webgl, isosurface |

## Links

- npm: https://www.npmjs.com/package/gl-isosurface3d
- Repository: https://github.com/gl-vis/gl-isosurface3d
- Homepage: https://github.com/gl-vis/gl-isosurface3d#readme
- Issues: https://github.com/gl-vis/gl-isosurface3d/issues
- npm.io page: https://npm.io/package/gl-isosurface3d

## Dependencies (14)

- [gl-vao](https://npm.io/package/gl-vao.md) ^1.1.3
- [gl-mat4](https://npm.io/package/gl-mat4.md) ^1.0.0
- [glslify](https://npm.io/package/glslify.md) ^6.1.0
- [ndarray](https://npm.io/package/ndarray.md) ^1.0.15
- [normals](https://npm.io/package/normals.md) ^1.0.1
- [colormap](https://npm.io/package/colormap.md) ^2.1.0
- [gl-buffer](https://npm.io/package/gl-buffer.md) ^2.0.8
- [gl-shader](https://npm.io/package/gl-shader.md) 4.2.1
- [barycentric](https://npm.io/package/barycentric.md) ^1.0.1
- [gl-texture2d](https://npm.io/package/gl-texture2d.md) ^2.0.8
- [typedarray-pool](https://npm.io/package/typedarray-pool.md) ^1.1.0
- [polytope-closest-point](https://npm.io/package/polytope-closest-point.md) ^1.0.0
- [simplicial-complex-contour](https://npm.io/package/simplicial-complex-contour.md) ^1.0.0
- [glsl-specular-cook-torrance](https://npm.io/package/glsl-specular-cook-torrance.md) ^2.0.1

## Recent versions

- 0.5.0 (latest) — 2018-07-18

## README

gl-isosurface3d
=====================
Visualization module for isosurfaces.

# Example

```javascript
var createScene      = require('gl-plot3d')
var createIsosurface = require('gl-isosurface3d')

var scene = createScene()

var width = 64
var height = 64
var depth = 64

var data = new Uint16Array(width*height*depth)
for (var z=0; z<depth; z++)
for (var y=0; y<height; y++)
for (var x=0; x<width; x++) {
	var value = 1500 + 500 * (
		Math.sin(3 * 2*Math.PI*(z/depth-0.5)) +
		Math.cos(4 * 2*Math.PI*(x/width-0.5)) +
		Math.sin(5 * 2*Math.PI*(h/height-0.5))
	);
	data[z*height*width + y*width + x] = value
}

var dims = [width, height, depth]
var bounds = [[0,0,0], [width, height, depth]]

var isoPlot = createIsosurface({
	values: data,
	dimensions: dims,
	isoBounds: [1600, 2000],
	vertexIntensityBounds: [1000, 2000],
	smoothNormals:  true,
	isoCaps: true,
	singleMesh: false,
	colormap: 'portland',
	capsColormap: 'jet'
}, bounds)

var mesh = createIsosurface.createTriMesh(gl, isoPlot)
var capMesh = createIsosurface.createTriMesh(gl, isoPlot.caps)

scene.add(mesh)
scene.add(capMesh)
```

[Try out the example in your browser](http://gl-vis.github.io/gl-isosurface3d/)

# Install

```
npm i gl-isosurface3d
```

# Basic interface

## Constructor

#### `var isosurface = require('gl-isosurface3d')(params, bounds)`
Creates an isosurface out of a 3D array.

* `params` is an object that has the following properties:

    + `values` *(Required)* An flattened 3D array of values
    + `dimensions` *(Required)* The dimensions of the array
    + `isoBounds` *(Recommended)* The range of values to envelop with the isosurface. Defaults to [1, Infinity], which creates an isosurface that has all values 1 and larger inside it.
    + `vertexIntensityBounds` *(Optional)* The range of values to map to [0..1] intensities. Defaults to the minimum and maximum values of the values array.
    + `smoothNormals` *(Optional)* Generate vertex normals for the isosurface. Defaults to false.
    + `isoCaps` *(Optional)* Generate caps for the isosurface. Defaults to false.
    + `singleMesh` *(Optional)* Merge isosurface and isocap meshes into a single mesh. Defaults to false, in which case the isocap mesh is stored in isoPlot.caps.
	+ `colormap` Name of the colormap to use for coloring the isosurface.
	+ `capsColormap` Name of the colormap to use for coloring the isocaps when using singleMesh = false. Defaults to the isosurface colormap.

* `bounds` is a bounds object that tells what part of the 3D array to display. It defaults to [[0, 0, 0], [width, height, depth]].

**Returns** An isosurface object that can be passed to isosurface3d.createTriMesh.

#### `var drawable = require('gl-isosurface3d').createTriMesh(params)`
Creates a drawable out of the isosurface triangle data. This is a version of gl-mesh3d optimized for fast loading of unindexed triangle meshes.

* `params` is an object that has the following properties:

    + `gl` A reference to the WebGL context
	+ `positions` *(Required)* Vertex positions array for the mesh, encoded as a flat Float32Array.
	+ `vertexNormals` *(Required)* Vertex normals for the mesh, encoded as a flat Float32Array.
	+ `vertexIntensity` Intensities of the vertices, used for intensity texture lookups.
	+ `colormap` Name of the colormap to use for coloring the vertices.
    + `vertexIntensityBounds` intensity range for the colormap
    + `ambientLight` ambient light color * intensity
    + `diffuseLight` diffuse light color * intensity
    + `specularLight` specular light color
    + `lightPosition` location of light
    + `roughness` surface roughness
    + `fresnel` surface glossiness/"rim light" factor
    + `opacity` surface opacity

**Returns** A drawable object that can be drawn on the passed gl context with drawable.draw(cameraParams);

# Credits
(c) 2013-2017 Mikola Lysenko, Ilmari Heikkinen. MIT License

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