JSVec2Array

An object for arrays of 2D coordinates.

Create a new Module.JSVec2Array API.

var vec_array = new Module.JSVec2Array();

Function

clear()

Initializes the vector list.

Information

Template

var vectorList = new Module.JSVec2Array();
vectorList.clear();

count() → number

Returns the number of vectors in the vector list.

Information

• Return

  • number: The number of vectors in the list.

Template

var vectorList = new Module.JSVec2Array();
// ...
vectorList.count();

get(index) → JSVector2D

Returns the vector object corresponding to the index.

Information

Name	Type	Description
index	number	The index of the vector to return.

• Return

  • A valid vector object (JSVector2D): Successfully returns the vector at the specified index.

  • An initialized object (JSVector2D): If the index exceeds the size of the vector list.

Template

var vectorList = new Module.JSVec2Array();
var vector = vectorList.get(2);

pop() → JSVector2D

Returns the last vector in the vector list.

After returning, the last vector is deleted from the vector list.

Information

• Return

  • A valid vector object (JSVector2D): Successfully returns the last vector.

  • An initialized object (JSVector2D): If the vector list is empty.

Template

var vectorList = new Module.JSVec2Array();
//...
var lastVector = vectorList.pop();

push(element) → number

Adds a new vector (JSVector2D).

Information

Name	Type	Description
element	JSVector2D	The new 2D vector object.

• Return

  • number: The number of vectors in the list after adding the new vector.

Template

var vectorList = new Module.JSVec2Array();
var newVector = new Module.JSVector2d(100.0, 150.0);
vectorList.push(newVector);

pushXY(dX, dY) → number

Adds a new vector object using x, y values.

Information

Name	Type	Description
dX	number	The x property of the new vector.
dY	number	The y property of the new vector.

• Return

  • number: The number of vectors in the list after adding the new vector.

Template

var vectorList = new Module.JSVec2Array();
vectorList.pushXY(100.0, 120.0);

set(index, vec)

Resets the value of the vector at the specified index.

Information

Name	Type	Description
index	number	The index of the vector to set.
vec	JSVector2D	The vector object to set.

Template

var vectorList = new Module.JSVec2Array();
//...
var newVector = new Module.JSVector2D(130.22, 149.3);
vectorList.set(5, newVector);

setXY(index, dX, dY)

Resets the value of the vector at the specified index using x, y values.

Information

Name	Type	Description
index	number	The index of the vector to set.
dX	number	The x value to set for the vector.
dY	number	The y value to set for the vector.

Template

var vectorList = new Module.JSVec2Array();
//...
vectorList.setXY(5, 130.22, 149.3);

shift()

Returns the first vector in the vector list and moves the order of the remaining vectors one position forward.

Information

• Return

  • A valid vector object (JSVector2D): Successfully returns the first vector.

  • An initialized object (JSVector2D): If the vector list is empty.

Template

var vectorList = new Module.JSVec2Array();
//...
var lastVector = vectorList.shift();