Need private packages and team management tools?Check out npm Teams »

perlin-noise-3d

0.5.3 • Public • Published

Perlin Noise

perlin-noise-3d

NPM Version gzip File Size

3D Perlin Noise as JavasScript module adapted from the original algorithm implemented by Ken Perlin on mrl.nyu.edu/~perlin/noise from the SIGGRAPH 2002 paper.

This is based on the previous adapting done by Rune Madsen on rune.noise.js, which was an adaptation from P5.js done by Daniel Shiffman, which was an adaptation from Processing / 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" ( fr010src.zip@files.scene.org ) adapted from the original work by Ken Perlin. — Props to all of them adaptors!


Install

$ 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:

// 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.

<script src="https://unpkg.com/perlin-noise-3d"></script>

Usage

Create an instance then you can get x, y and z values.

const noise = new perlinNoise3d();
      noise.get(x, y, z);

Plant a seed with noiseSeed. i.e:

      noise.noiseSeed(Math.E);

— Example #01 : linear x and noised y

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

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.

Install

npm i perlin-noise-3d

DownloadsWeekly Downloads

22

Version

0.5.3

License

none

Unpacked Size

17.8 kB

Total Files

6

Last publish

Collaborators

  • avatar