Module: og/utils/shared

Methods

(static) getLinesIntersection2v(start1, end1, start2, end2, isSegmentopt) → {Vec2}

Returns two segment lines intersection coordinate.

Parameters:

Name	Type	Attributes	Description
`start1`	Vec2		First line first coordinate.
`end1`	Vec2		First line second coordinate.
`start2`	Vec2		Second line first coordinate.
`end2`	Vec2		Second line second coordinate.
`isSegment`	boolean	<optional>	Lines are segments.

Source: utils/shared.ts, line 360

Returns:

Intersection coordinate.

Type:: Vec2

(static) getLinesIntersectionLonLat(start1, end1, start2, end2, isSegmentopt) → {Vec2}

Returns two segment lines intersection coordinate.

Parameters:

Name	Type	Attributes	Default	Description
`start1`	Vec2			First line first coordinate.
`end1`	Vec2			First line second coordinate.
`start2`	Vec2			Second line first coordinate.
`end2`	Vec2			Second line second coordinate.
`isSegment`	boolean	<optional>	false	Lines are segments.

Source: utils/shared.ts, line 400

Returns:

Intersection coordinate.

Type:: Vec2

(static) getMatrixSubArray32(sourceArr, gridSize, i0, j0, size) → {Float32Array}

Returns 32-bit triangle coordinate array from inside of the source triangle array.

Parameters:

Name	Type	Description
`sourceArr`	TypedArray \| Array.<number>	Source array
`gridSize`	number	Source array square matrix size
`i0`	number	First row index source array matrix
`j0`	number	First column index
`size`	number	Square matrix result size.

Source: utils/shared.ts, line 927

Returns:

Triangle coordinates array from the source array.

Type:: Float32Array

(static) getMatrixSubArray64(sourceArr, gridSize, i0, j0, size) → {Float64Array}

Returns 64-bit triangle coordinate array from inside of the source triangle array.

Parameters:

Name	Type	Description
`sourceArr`	TypedArray \| Array.<number>	Source array
`gridSize`	number	Source array square matrix size
`i0`	number	First row index source array matrix
`j0`	number	First column index
`size`	number	Square matrix result size.

Source: utils/shared.ts, line 893

Returns:

Triangle coordinates array from the source array.

Type:: Float64Array

(static) xmlToJson(xml) → {Object}

Converts XML to JSON

Parameters:

Name	Type	Description
`xml`	Object	Xml object

Source: utils/shared.ts, line 440

Returns:

Json converted object.

Type:: Object

(inner) binaryInsert(ar, el, compare_fn) → {number}

Parameters:

Name	Type	Description
`ar`	Array.<any>	The sorted array to insert.
`el`	any	The item to insert.
`compare_fn`	function	comparator The function to use to compare the item to elements in the array.

Source: utils/shared.ts, line 342

Returns:

Array index position in which item inserted in.

Type:: number

(inner) binarySearch(ar, el, compare_fn) → {number}

Finds an item in a sorted array.

Parameters:

Name	Type	Description
`ar`	Array.<any>	The sorted array to search.
`el`	any	The item to find in the array.
`compare_fn`	function	comparator The function to use to compare the item to elements in the array.

Source: utils/shared.ts, line 309

Returns:

a negative number if 'a' is less than 'b'; 0 if 'a' is equal to 'b'; 'a' positive number of 'a' is greater than 'b'.

Type:: number

Example

// Create a comparator function to search through an array of numbers.
function comparator(a, b) {
    return a - b;
};
var numbers = [0, 2, 4, 6, 8];
var index = og.utils.binarySearch(numbers, 6, comparator); // 3

(inner) blerp(x, y, fQ11, fQ21, fQ12, fQ22, x1opt, x2opt, y1opt, y2opt)

y2-----Q12--------------Q22--- | | | | | | | | y-------|-----P----------|---- | | | | | | | | | | | | | | | | | | | | y1-----Q11----|---------Q21--- | | | | | | x1 x x2

Parameters:

Name	Type	Attributes	Default
`x`	Number
`y`	Number
`fQ11`	Number
`fQ21`	Number
`fQ12`	Number
`fQ22`	Number
`x1`	Number	<optional>	0.0
`x2`	Number	<optional>	1.0
`y1`	Number	<optional>	0.0
`y2`	Number	<optional>	1.0

Source: utils/shared.ts, line 628

(inner) concatArrays(aopt, bopt) → {TypedArray|Array.<number>}

Concatenates two the same arrays

Parameters:

Name	Type	Attributes	Default	Description
`a`	TypedArray \| Array.<number>	<optional>	[]	First array
`b`	TypedArray \| Array.<number>	<optional>	[]	Second array

Source: utils/shared.ts, line 793

Returns:

Type:: TypedArray | Array.<number>

(inner) concatTypedArrays(a, b)

Concatenates two the same type arrays

Parameters:

Name	Type	Description
`a`	TypedArray
`b`	TypedArray \| Array.<number>

Source: utils/shared.ts, line 781

(inner) getMatrixSubArrayBoundsExt()

Returns two float32 triangle coordinate arrays from inside of the source triangle array.

Source: utils/shared.ts, line 960

(inner) htmlColorToRgb(htmlColor) → {Vec3}

Convert html color string to the RGB number vector.

Parameters:

Name	Type	Description
`htmlColor`	string	HTML string("#C6C6C6" or "#EF5" or "rgb(8,8,8)" or "rgba(8,8,8)") color.

Source: utils/shared.ts, line 114

Returns:

Type:: Vec3

(inner) htmlColorToRgba(htmlColor, opacityopt) → {Vec4}

Convert html color string to the RGBA number vector.

Parameters:

Name	Type	Attributes	Description
`htmlColor`	string		HTML string("#C6C6C6" or "#EF5" or "rgb(8,8,8)" or "rgba(8,8,8)") color.
`opacity`	number	<optional>	Opacity for the output vector.

Source: utils/shared.ts, line 67

Returns:

Type:: Vec4

(inner) isImageLoaded(image) → {boolean}

Gets image is loaded

Parameters:

Name	Type	Description
`image`	HTMLImageElement

Source: utils/shared.ts, line 1046

Returns:

Returns true is the image is loaded

Type:: boolean

(inner) isUndef(obj) → {boolean}

Returns true if the object pointer is undefined.

Parameters:

Name	Type	Description
`obj`	Object	Object pointer.

Source: utils/shared.ts, line 21

Returns:

Returns true if object is undefined.

Type:: boolean

(async, inner) loadImage(url) → {Promise.<Image>}

Promise for load images

Parameters:

Name	Type	Description
`url`	string	link to image.

Source: utils/shared.ts, line 1028

Returns:

Returns promise.

Type:: Promise.<Image>

(inner) makeArray(arr) → {Array.<number>}

Convert typed array to array

Parameters:

Name	Type	Description
`arr`	TypedArray \| Array.<number>

Source: utils/shared.ts, line 826

Returns:

Type:: Array.<number>

(inner) makeArrayTyped(arr, ctor) → {TypedArray}

Convert simple array to typed

Parameters:

Name	Type	Description
`arr`	Array.<number>
`ctor`	Float32Array

Source: utils/shared.ts, line 810

Returns:

Type:: TypedArray

(inner) spliceArray(arr, starting, deleteCount, outopt)

Parameters:

Name	Type	Attributes
`arr`	TypedArray \| Array
`starting`	Number
`deleteCount`	Number
`out`	Object	<optional>

Source: utils/shared.ts, line 839

(inner) spliceTypedArray(arr, starting, deleteCount, outopt)

Parameters:

Name	Type	Attributes
`arr`	TypedArray
`starting`	Number
`deleteCount`	Number
`out`	Object	<optional>

Source: utils/shared.ts, line 870

(inner) stringTemplate(template, params) → {string}

Replace template substrings between '{' and '}' tokens.

Parameters:

Name	Type	Description
`template`	string	String with templates in "{" and "}"
`params`	Object	Template named object with subsrtings.

Source: utils/shared.ts, line 150

Returns:

Type:: string

Example

Example from og.terrain that replaces tile indexes in url:

var substrings = {
      "x": 12,
      "y": 15,
      "z": 8
}
og.utils.stringTemplate("http://earth3.openglobus.org/{z}/{y}/{x}.ddm", substrings);
//returns http://earth3.openglobus.org/8/15/12.ddm

(inner) throttle(func, limit, skipopt)

Callback throttling

Parameters:

Name	Type	Attributes	Default
`func`	any
`limit`	Number
`skip`	boolean	<optional>	false

Source: utils/shared.ts, line 600