Global

Methods

arrayEquals(a1, a2) → {boolean}

Check if both array are equals

Parameters:

Name	Type	Description
`a1`	Array	array 1
`a2`	Array	array 2

Source: index.js, line 469

Returns:

true if equals

Type:: boolean

arrayPushOnce(array, element) → {boolean}

Check if the element is alreeady included in the array if not push it

Parameters:

Name	Type	Description
`array`	Array	array where to push the element
`element`	*	element to push

Source: index.js, line 506

Returns:

true if pushed false otherwise

Type:: boolean

checkIfSubStringIsEuler(subString) → {boolean}

Take an array of string and check if it is in euler format

Parameters:

Name	Type	Description
`subString`	Array.<string>	array of string

Source: index.js, line 101

Returns:

true if it is euler format

Type:: boolean

checkIfSubStringIsMatrix4(subString) → {boolean}

Take an array of string and check if it is in matrix4 format

Parameters:

Name	Type	Description
`subString`	Array.<string>	array of string

Source: index.js, line 162

Returns:

true if it is matrix4 format

Type:: boolean

checkIfSubStringIsVector3(subString) → {boolean}

Take an array of string and check if it is in vector3 format

Parameters:

Name	Type	Description
`subString`	Array.<string>	array of string

Source: index.js, line 78

Returns:

true if it is vector3 format

Type:: boolean

computeFileFormat(filename) → {string}

Compute the last string after the . in the filename

Parameters:

Name	Type	Description
`filename`	string	file name

Source: index.js, line 483

Returns:

file format

Type:: string

computeFilenameFromPath(path) → {string}

Compute filename from path

Parameters:

Name	Type	Description
`path`	string	path

Source: index.js, line 494

Returns:

filename

Type:: string

dataUriToBuffer(uri) → {Buffer|null}

Convert a data URI into a Buffer

Parameters:

Name	Type	Description
`uri`	string	data uri to convert

Source: index.js, line 231

Returns:

the buffer of the data uri or null if uri is not a data uri

Type:: Buffer | null

eulerArrayFromURIComponent(uriComp) → {Array.<string>}

Taking a string from the unpacking URI and splitting it into an array of strings.

Parameters:

Name	Type	Description
`uriComp`	string	The string from the unpacking URI

Source: index.js, line 147

Returns:

returns the array of strings if it is in euler format, otherwise returns null

Type:: Array.<string>

getAttributeByPath(obj, path) → {*}

Gets an attribute of an object from the given path. To get nested attributes, the path qualifiers must be separated by dots ('.'). If the path is not nested (does not contain any dot), the function is equivalent to obj[path].

Parameters:

Name	Type	Description
`obj`	object	object to get attribute
`path`	string	path to get the attribute

Source: index.js, line 348

Returns:

attribute vaue

Type:: *

Example

const obj = {test: {msg: "Hello world !"}};
console.log(getAttributeByPath(obj, "test.msg")); // prints "Hello world !";
console.log(getAttributeByPath(obj, "other")); // undefined

imageToDataURI(arrayBuffer, mimeType, chunkSize) → {string}

Converts the raw content of an array buffer (as retrieved by a GET request on a file) to a data URI. This is required, for example, to display images fetched from the server. As we need authentication headers to retrieve some protected files, we get the raw data dynamically and need to convert it to a data URI do display it. The basic scheme of the URI is defined in the RFC 2397, with the mediaType set to mimeType and the raw data converted to base64.

Parameters:

Name	Type	Description
`arrayBuffer`	ArrayBuffer	The binary data of the file.
`mimeType`	string	The media type. Any type supported by a data URI should work. For images, use `image/png` or `image/jpeg` for instance.
`chunkSize`	number	The size of the chunks used to process the raw data. If you get an exception saying that too many arguments were passed as parameters, try reducing this value.

Source: index.js, line 315

Returns:

data uri

Type:: string

insert(originalString, index, string) → {string}

Parameters:

Name	Type	Description
`originalString`	string	string to modify
`index`	number	where to insert
`string`	string	to insert

Source: index.js, line 538

Returns:

string injected

Type:: string

int32ArrayToObject(array) → {object}

Convert a Int32Array into an Object

Parameters:

Name	Type	Description
`array`	Int32Array	array to convert

Source: index.js, line 220

Returns:

object converted

Type:: object

isNumeric(str) → {boolean}

Check if a string is a valid number inspired of https://stackoverflow.com/questions/175739/built-in-way-in-javascript-to-check-if-a-string-is-a-valid-number

Parameters:

Name	Type	Description
`str`	string	string to check

Source: index.js, line 61

Returns:

true if it's a valid number

Type:: boolean

matrix4ArrayFromURIComponent(uriComp) → {Array.<string>}

Taking a string from the unpacking URI and splitting it into an array of strings.

Parameters:

Name	Type	Description
`uriComp`	string	The string from the unpacking URI

Source: index.js, line 185

Returns:

returns the array of strings if it is in matrix4 format, otherwise returns null

Type:: Array.<string>

objectEquals(json1, json2) → {boolean}

Check if two json object are equals

Parameters:

Name	Type	Description
`json1`	object	first json object
`json2`	object	second json object

Source: index.js, line 367

Returns:

true if both json are equals, false otherwise

Type:: boolean

objectOverWrite(jsonOverWrited, jsonModel) → {object}

Overwrite identical key of jsonOverWrited with the one matching in jsonModel Create key of jsonModel which are not in jsonOverWrited

Parameters:

Name	Type	Description
`jsonOverWrited`	object	json object overwrited
`jsonModel`	object	json object used as model to overwrite

Source: index.js, line 401

Returns:

json object overwrited

Type:: object

objectParse(object, cb) → {object}

Apply a callback to each key value couple of an object

Parameters:

Name	Type	Description
`object`	object	object to parse
`cb`	function	callback to apply (first argument is the object containing the key and second is the key)

Source: index.js, line 437

Returns:

object parsed

Type:: object

objectParseNumeric(json) → {object}

Replace all valid number string in a json object by a float

Parameters:

Name	Type	Description
`json`	object	json object to parse

Source: index.js, line 454

Returns:

json object parsed

Type:: object

objectToInt32Array(obj) → {Int32Array}

Convert an Object into a Int32Array

Parameters:

Name	Type	Description
`obj`	object	object to convert

Source: index.js, line 200

Returns:

array converted

Type:: Int32Array

polygon2DArea(points) → {number}

Parameters:

Name	Type	Description
`points`	Array.<{x:number, y:number}>	points of your polygon not closed

Source: index.js, line 22

Returns:

the area of your polygon

Type:: number

removeEmptyValues(formData) → {FormData}

Removes empty fields from a FormData. Useful for update requests that would update those fields to an empty string if they were sent in the body. To check if a value is empty, this function just convert it into a boolean.

Parameters:

Name	Type	Description
`formData`	FormData	The form data.

Source: index.js, line 284

Returns:

The same data, without the fields containing an empty value.

Type:: FormData

removeFromArray(array, element) → {boolean}

Remove an element if it's present in an array

Parameters:

Name	Type	Description
`array`	Array	array to remove element from
`element`	*	element to remove

Source: index.js, line 521

Returns:

true if removed false otherwise

Type:: boolean

rotate2DCoord(x, y, angle) → {Object}

Parameters:

Name	Type	Description
`x`	number	x coor
`y`	number	y coord
`angle`	number	rotation angle in radian

Source: index.js, line 10

Returns:

x y rotated by angle

Type:: Object

round(number) → {string}

Parameters:

Name	Type	Description
`number`	number	number to round

Source: index.js, line 555

Returns:

rounded number

Type:: string

throttle(fn, delay) → {*}

Limit the execution of a function every delay ms

Parameters:

Name	Type	Description
`fn`	function	function to be throttled
`delay`	number	delay in ms

Source: index.js, line 42

Returns:

return what the function should return every delay ms

Type:: *

vector3ArrayFromURIComponent(uriComp) → {Array.<string>}

Taking a string from the unpacking URI and splitting it into an array of strings.

Parameters:

Name	Type	Description
`uriComp`	string	The string from the unpacking URI

Source: index.js, line 132

Returns:

returns the array of strings if it is in vector3 format, otherwise returns null

Type:: Array.<string>

vector3ToLabel(v) → {string}

Parameters:

Name	Type	Description
`v`	Object	vector 3 to labelize

Source: index.js, line 565

Returns:

vector labelified

Type:: string

Type Definitions

ProcessIntervalTickRequester(dt)

Callback function for ProcessInterval to execute on each tick.

Parameters:

Name	Type	Description
`dt`	number	The time elapsed since the last tick in milliseconds.

Source: ProcessInterval.js, line 1