Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alterebro/perlin-noise-3d
3D Perlin Noise
https://github.com/alterebro/perlin-noise-3d
3d noise noise-generator perlin perlin-noise
Last synced: 3 months ago
JSON representation
3D Perlin Noise
- Host: GitHub
- URL: https://github.com/alterebro/perlin-noise-3d
- Owner: alterebro
- Created: 2019-05-05T13:54:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-30T08:51:19.000Z (4 months ago)
- Last Synced: 2024-11-01T08:18:47.814Z (3 months ago)
- Topics: 3d, noise, noise-generator, perlin, perlin-noise
- Language: JavaScript
- Homepage: https://npm.im/perlin-noise-3d
- Size: 313 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# perlin-noise-3d
[](https://www.npmjs.com/package/perlin-noise-3d) [](https://unpkg.com/perlin-noise-3d/dist/perlin-noise-3d.min.js)
3D [Perlin Noise](https://en.wikipedia.org/wiki/Perlin_noise) as JavasScript module adapted from the original algorithm implemented by **Ken Perlin** on [mrl.nyu.edu/~perlin/noise](https://mrl.nyu.edu/~perlin/noise/) from the [SIGGRAPH 2002 paper](http://mrl.nyu.edu/~perlin/paper445.pdf).
This is based on the previous adapting done by **Rune Madsen** on [rune.noise.js](https://github.com/runemadsen/rune.noise.js), which was an adaptation from [P5.js](https://github.com/processing/p5.js/blob/master/src/math/noise.js) done by **Daniel Shiffman**, which was an adaptation from [Processing / PApplet.java](https://github.com/processing/processing/blob/master/core/src/processing/core/PApplet.java) done by **Ben Fry**, which was an adaptation from the contributions by **Karsten Schmidt** aka **toxi** adapting the code created by the German demo scene group **Farbrausch** on their demo production "*art*" ( [[email protected]](https://files.scene.org/view/resources/code/sources/fr010src.zip) ) adapted from the original work by **Ken Perlin**. — **Props to all of them adaptors!**
---
## Install
```sh
$ npm install perlin-noise-3d
```
There are two available files for this module:
- `dist/perlin-noise-3d.js` › CommonJS & ES Module
- `dist/perlin-noise-3d.min.js` › UMD
Include `perlin-noise-3d`:
```javascript
// ES6
import perlinNoise3d from 'perlin-noise-3d'
// CJS
const perlinNoise3d = require('perlin-noise-3d');
```
Include the minified UMD file for the browser ( `dist/perlin-noise-3d.min.js` ) or you can add the script directly from [unpkg](https://unpkg.com/perlin-noise-3d).
```html
```
## Usage
Create an instance then you can get `x`, `y` and `z` values.
```javascript
const noise = new perlinNoise3d();
noise.get(x, y, z);
```
Plant a seed with `noiseSeed`. *i.e:*
```javascript
noise.noiseSeed(Math.E);
```
### — Example #01 : `linear` x and `noised y`
```javascript
const noise = new perlinNoise3d();
let noiseStep = 0;
for(let x = 0; x < 50; x++ ) {
let y = noise.get(noiseStep) * 100;
console.log(x, Math.floor(y));
noiseStep += 0.1;
}
```
### — Example #02 : plotting a 2D square graph using a seed
```javascript
let n = new perlinNoise3d();
n.noiseSeed(Math.PI);
let size = 10;
let output = [];
for (let x = 0; x < size; x++) {
for (let y = 0; y < size; y++) {
output.push({ x:x, y:y, value: n.get(x/10, y/10)});
}
}
console.table(output);
```
## API
### `perlinNoise3d`
Returns an `object`.
You can create your instance as follows: `let noise = new perlinNoise3d;`
### `noise.get(x, y, z)`
Returns a `float` : `x`, `y`, `z` are the coordinates where you want to get the value. Both second and third parameter are optional.
### `noise.noiseSeed(seed)`
Set a seed value (`float`) to get different noise depending on the noise value.