# yy-noise

> a javascript simple noise generator based on code from from {@link http://www.scratchapixel.com/old/lessons/3d-advanced-lessons/noise-part-1/creating-a-simple-1d-noise/}, via {@link http://www.michaelbromley.co.uk/blog/90/simple-1d-noise-in-javascript}

Latest version **1.0.1** (published 2016-09-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install yy-noise
pnpm add yy-noise
yarn add yy-noise
bun add yy-noise
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-09-19 |
| First published | 2016-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | David Figatner |
| Maintainers | davidfig |

## Links

- npm: https://www.npmjs.com/package/yy-noise
- Repository: https://github.com/davidfig/noise
- Homepage: https://github.com/davidfig/noise#readme
- Issues: https://github.com/davidfig/noise/issues
- npm.io page: https://npm.io/package/yy-noise

## Recent versions

- 1.0.1 (latest) — 2016-09-19
- 1.0.0 — 2016-09-19

## README

## noise.js
a javascript simple noise generator
based on code from from [scratchapixel.com](http://www.scratchapixel.com/old/lessons/3d-advanced-lessons/noise-part-1/creating-a-simple-1d-noise/), via [Michael Bromley](http://www.michaelbromley.co.uk/blog/90/simple-1d-noise-in-javascript)

## Installation

    npm install yy-noise

# API Reference
creates simple 1D noise this.generator

**Kind**: global class  

* [SimpleNoise](#SimpleNoise)
    * [new SimpleNoise(options, [maxVertices], [amplitude], [scale])](#new_SimpleNoise_new)
    * [.get(x)](#SimpleNoise+get) ⇒ <code>number</code>
    * [.lerp(a, b, t)](#SimpleNoise+lerp) ⇒ <code>number</code>

<a name="new_SimpleNoise_new"></a>

### new SimpleNoise(options, [maxVertices], [amplitude], [scale])

| Param | Type | Default |
| --- | --- | --- |
| options | <code>object</code> |  | 
| [maxVertices] | <code>number</code> | <code>256</code> | 
| [amplitude] | <code>number</code> | <code>1</code> | 
| [scale] | <code>number</code> | <code>1</code> | 

**Example**  
```js
const noise = new SimpleNoise({maxVertices: 512, noise: 0.5, scale: 0.25});

     // changes amplitude of noise function
     noise.amplitude = amplitude;

     // sets scale of noise function
     noise.scale = scale;

     // returns the value based on n (usually incremented along an axis)
     for (let x = 0; x < 100; x++)
     {
         noise.get(n);
     }
```
<a name="SimpleNoise+get"></a>

### simpleNoise.get(x) ⇒ <code>number</code>
gets a value

**Kind**: instance method of <code>[SimpleNoise](#SimpleNoise)</code>  

| Param | Type |
| --- | --- |
| x | <code>number</code> | 

<a name="SimpleNoise+lerp"></a>

### simpleNoise.lerp(a, b, t) ⇒ <code>number</code>
Linear interpolation function.

**Kind**: instance method of <code>[SimpleNoise](#SimpleNoise)</code>  

| Param | Type | Description |
| --- | --- | --- |
| a | <code>number</code> | The lower integer value |
| b | <code>number</code> | The upper integer value |
| t | <code>number</code> | The value between the two |


* * *

Copyright (c) 2016 YOPEY YOPEY LLC - MIT License - Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown)

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