# generate-heightmap-mesh

> generate a triangle mesh from a distance function

Latest version **0.0.162** (published 2023-10-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install generate-heightmap-mesh
pnpm add generate-heightmap-mesh
yarn add generate-heightmap-mesh
bun add generate-heightmap-mesh
```

## 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.162 |
| Published | 2023-10-18 |
| First published | 2022-01-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | stonkpunk |
| Maintainers | stonkpunk |
| Keywords | triangles, heightmap, mesh |

## Links

- npm: https://www.npmjs.com/package/generate-heightmap-mesh
- Homepage: https://github.com/stonkpunk/my-npm-modules/tree/main/generate-heightmap-mesh
- npm.io page: https://npm.io/package/generate-heightmap-mesh

## Dependencies (2)

- [simplex-noise](https://npm.io/package/simplex-noise.md) ^3.0.1
- [simplify-triangles](https://npm.io/package/simplify-triangles.md) ^0.0.17

## Recent versions

- 0.0.162 (latest) — 2023-10-18
- 0.0.161 — 2022-09-22
- 0.0.16 — 2022-04-05
- 0.0.15 — 2022-04-02
- 0.0.14 — 2022-03-09
- 0.0.13 — 2022-03-09
- 0.0.12 — 2022-03-09
- 0.0.11 — 2022-01-30
- 0.0.1 — 2022-01-30

## README

# generate-heightmap-mesh

generate a triangle mesh from a distance function

```sh
npm i generate-heightmap-mesh
```
```javascript
//height function format:
function(x,y,z,scale){ //note - y is usually assumed to be constant
    return height_at_point(x/scale,y,z/scale);
}
```
by default the height function generates islands created from simplex noise

```javascript

var gen = require('generate-heightmap-mesh');

var resolution = 256; //x-z resolution of mesh
var size = 64;
var boundingBox_XZ = [[-size,0,-size],[size,0,size]];
var df = gen.dfHillsWorld2D; //default distance function
var yCoordinate=0.0; //y-coord to use in 3d distance function sampler
var df_scaleXZ=100.0; //scale df along x-z, default 100 -- you can leave this constant to have the bounding box reveal more land as it expands, OR make this value proportional to the bounding box, to have the result expand to the same size as the bounding box
var df_scaleY=4; //scale result height, default 4
var postSimplifyFactor=0.5; //default 1 [no simplify] -- if less than 1, decimate triangles to the fraction indicated
var doAddSkirt = false; //add "skirt" to heightmap to make it an enclosed mesh. default false.
var skirtY = -10; //y coord for the skirt floor. default 0. 

var triangles = gen.generateHeightmapMeshXZ(resolution, boundingBox_XZ, df, yCoordinate, df_scaleXZ, df_scaleY, postSimplifyFactor, doAddSkirt, skirtY);

//view result with ascii-raytracer
var art = require('ascii-raytracer');
var config = {
    triangles:triangles,
    resolution: 64,
    aspectRatio: 1.0,
    cameraMode: 0,
    mouseControl:true,
    antiAlias: true
}

art.runScene(config);
```

![1](https://i.imgur.com/bDnQpBD.png)

^ resulting heightmap mesh

![2](https://i.imgur.com/drKLLh7.png)

^ result with skirt added [here skirtY=-10]

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

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