Class: Rand

Rand

new Rand(seed)

utilities/Rand.js, line 7
Wrapper library for David Bau's seeded random number generator which is a wrapper for the Math.rand() functionality. This library is implemented to fill out the functionality of the random capabilities as well as build on the capabilities existing in the framework currently. This class can be used on a global or local scale.
Name Type Default Description
seed number | string 0 optional The seed to be applied to the local random number generator
See:
Examples
Rand.seedRandom(0);      // Set the global seed
Rand.rand();             // Predictable based off seed
var rng = new Rand(0);   // Set the local rng seed
rng.rand();              // Predictable based off seed

Rand.rand();             // Unpredictable since global seed is not set

Methods

staticRand.rand(){number}

utilities/Rand.js, line 78
Get a random number from 0 to 1.
Returns:
Type Description
number random number from 0 to 1

staticRand.randHex(){hex}

utilities/Rand.js, line 208
Get the random hex value of a color represented in the hexidecimal format
Returns:
Type Description
hex

staticRand.randHexColor(){string}

utilities/Rand.js, line 246
Get a random hex color string represented in "#HEXSTR" format
Returns:
Type Description
string

staticRand.randInt(min, max){number}

utilities/Rand.js, line 167
Get a random int in a particular range (min and max inclusive)
Name Type Description
min any
max any
Returns:
Type Description
number Random float number from min (inclusive) to max (exclusive)

staticRand.randRange(min, max){number}

utilities/Rand.js, line 120
Get a random float value in a particular range
Name Type Description
min any
max any
Returns:
Type Description
number Random float number from min (inclusive) to max (exclusive)

staticRand.setSeed(seed)

utilities/Rand.js, line 44
Set the global seed for the seeded random number generator. After the seed has been set. The random numbers will be predictable and repeatable given the same input seed. If no seed is specified, then a random seed will be assigned to the random number generator using added system entropy.
Name Type Default Description
seed number | string 0 optional The seed to be applied to the global random number generator

staticRand.vector(bbox){Vector}

utilities/Rand.js, line 289
Get a random vector in a bounding box
Name Type Description
bbox Rectangle The bounding box of the random vector
Returns:
Type Description
Vector A random vector

rand(){number}

utilities/Rand.js, line 89
Get a random number from 0 to 1.
Returns:
Type Description
number random number from 0 to 1

randHex(){hex}

utilities/Rand.js, line 219
Get the random hex value of a color represented in the hexidecimal format
Returns:
Type Description
hex

randHexColor(){string}

utilities/Rand.js, line 258
Get a random hex color string represented in "#HEXSTR" format
Returns:
Type Description
string

randInt(min, max){number}

utilities/Rand.js, line 181
Get a random int in a particular range (min and max inclusive)
Name Type Description
min any
max any
Returns:
Type Description
number Random float number from min (inclusive) to max (exclusive)

randRange(min, max){number}

utilities/Rand.js, line 134
Get a random float value in a particular range
Name Type Description
min any
max any
Returns:
Type Description
number Random float number from min (inclusive) to max (exclusive)

setSeed(seed)

utilities/Rand.js, line 63
Set the seed for the seeded random number generator. After the seed has been set. The random numbers will be predictable and repeatable given the same input seed. If no seed is specified, then a random seed will be assigned to the random number generator using added system entropy.
Name Type Default Description
seed number | string 0 optional The seed to be applied to the RNG

vector(bbox){Vector}

utilities/Rand.js, line 301
Get a random vector in a bounding box
Name Type Description
bbox Rectangle The bounding box of the random vector
Returns:
Type Description
Vector A random vector