Skip to content

Commit

Permalink
chore(release): 2.0.0-alpha.2
Browse files Browse the repository at this point in the history
  • Loading branch information
dmnsgn committed Aug 30, 2023
1 parent 5f0e35f commit 09cf472
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 14 deletions.
11 changes: 10 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.

# [2.0.0-alpha.2](https://github.com/pex-gl/pex-random/compare/v2.0.0-alpha.1...v2.0.0-alpha.2) (2023-08-30)


### Features

* add random quat ([574efcd](https://github.com/pex-gl/pex-random/commit/574efcda418c1692aa3a76544c767805f4299ce9))



# [2.0.0-alpha.1](https://github.com/pex-gl/pex-random/compare/v2.0.0-alpha.0...v2.0.0-alpha.1) (2022-09-07)

Expand Down
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Notes:
- [.vec3([r])](#Random+vec3) ⇒ <code>module:pex-math~vec3</code>
- [.vec2InRect(rect)](#Random+vec2InRect) ⇒ <code>module:pex-math~vec2</code>
- [.vec3InAABB(bbox)](#Random+vec3InAABB) ⇒ <code>module:pex-math~vec3</code>
- [.quat()](#Random+quat) ⇒ <code>module:pex-math~quat</code>
- [.chance([probability])](#Random+chance) ⇒ <code>boolean</code>
- [.element(list)](#Random+element) ⇒ <code>\*</code>
- [.noise2(x, y)](#Random+noise2) ⇒ <code>number</code>
Expand All @@ -110,7 +111,7 @@ Notes:

### new Random([seed])

Creates an instance of Random
Creates an instance of Random.

| Param | Type | Default |
| ------ | ------------------------------------------ | ----------------------------------------------------------- |
Expand All @@ -132,7 +133,7 @@ Create an instance of Random.

### random.seed(s)

Set the seed for the random number generator
Set the seed for the random number generator.

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

Expand Down Expand Up @@ -176,7 +177,7 @@ Get an int between min and max. Defaults to:

### random.vec2([r]) ⇒ <code>module:pex-math~vec2</code>

Get a vec2 included in a radius
Get a vec2 included in a radius.

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

Expand All @@ -188,7 +189,7 @@ Get a vec2 included in a radius

### random.vec3([r]) ⇒ <code>module:pex-math~vec3</code>

Get a vec3 included in a radius
Get a vec3 included in a radius.

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

Expand All @@ -200,7 +201,7 @@ Get a vec3 included in a radius

### random.vec2InRect(rect) ⇒ <code>module:pex-math~vec2</code>

Get a vec2 included in a rectangle
Get a vec2 included in a rectangle.

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

Expand All @@ -212,14 +213,22 @@ Get a vec2 included in a rectangle

### random.vec3InAABB(bbox) ⇒ <code>module:pex-math~vec3</code>

Get a vec3 included in a rectangle bbox
Get a vec3 included in a rectangle bbox.

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

| Param | Type | Description |
| ----- | ------------------- | -------------- |
| bbox | <code>number</code> | rectangle bbox |

<a name="Random+quat"></a>

### random.quat() ⇒ <code>module:pex-math~quat</code>

Get a random quaternion.

**Kind**: instance method of [<code>Random</code>](#Random)
**See**: [Steve LaValle](https://web.archive.org/web/20211105205926/http://planning.cs.uiuc.edu/node198.html)
<a name="Random+chance"></a>

### random.chance([probability]) ⇒ <code>boolean</code>
Expand All @@ -236,7 +245,7 @@ Returns a chance of an event occuring according to a given probability between 0

### random.element(list) ⇒ <code>\*</code>

Gets a random element from a list
Gets a random element from a list.

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

Expand All @@ -248,7 +257,7 @@ Gets a random element from a list

### random.noise2(x, y) ⇒ <code>number</code>

Samples the noise field in 2 dimensions
Samples the noise field in 2 dimensions.

**Kind**: instance method of [<code>Random</code>](#Random)
**Returns**: <code>number</code> - in the interval [-1, 1]
Expand All @@ -262,7 +271,7 @@ Samples the noise field in 2 dimensions

### random.noise3(x, y, z) ⇒ <code>number</code>

Samples the noise field in 3 dimensions
Samples the noise field in 3 dimensions.

**Kind**: instance method of [<code>Random</code>](#Random)
**Returns**: <code>number</code> - in the interval [-1, 1]
Expand All @@ -277,7 +286,7 @@ Samples the noise field in 3 dimensions

### random.noise4(x, y, z, w) ⇒ <code>number</code>

Samples the noise field in 4 dimensions
Samples the noise field in 4 dimensions.

**Kind**: instance method of [<code>Random</code>](#Random)
**Returns**: <code>number</code> - in the interval [-1, 1]
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "pex-random",
"version": "2.0.0-alpha.1",
"version": "2.0.0-alpha.2",
"description": "Random value generators (float, int, vector and noise) for PEX.",
"keywords": [
"pex",
Expand Down

0 comments on commit 09cf472

Please sign in to comment.