Class: Vector2

Constructor

new Vector2(xopt, yopt)

Create a 2D vector with the x and y passed in, can also be created with vec2()

Parameters:

Name	Type	Attributes	Default	Description
`x`	number	<optional>	0	X axis location
`y`	number	<optional>	0	Y axis location

Source: src/engineUtilities.js, line 327

Example

let a = new Vector2(2, 3); // vector with coordinates (2, 3)
let b = new Vector2;       // vector with coordinates (0, 0)
let c = vec2(4, 2);        // use the vec2 function to make a Vector2
let d = a.add(b).scale(5); // operators can be chained

Members

x

Properties

Type	Description
number	X axis location

Source: src/engineUtilities.js, line 335

y

Properties

Type	Description
number	Y axis location

Source: src/engineUtilities.js, line 337

Methods

add(v) → {Vector2}

Returns a copy of this vector plus the vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector

Source: src/engineUtilities.js, line 360

Returns:

Type:: Vector2

angle() → {number}

Returns the clockwise angle of this vector, up is angle 0

Source: src/engineUtilities.js, line 466

Returns:

Type:: number

area() → {number}

Returns the area this vector covers as a rectangle

Source: src/engineUtilities.js, line 514

Returns:

Type:: number

arrayCheck(arraySize) → {boolean}

Returns true if this vector is within the bounds of an array size passed in

Parameters:

Name	Type	Description
`arraySize`	Vector2

Source: src/engineUtilities.js, line 529

Returns:

Type:: boolean

clampLength(lengthopt) → {Vector2}

Returns a new vector clamped to length passed in

Parameters:

Name	Type	Attributes	Default	Description
`length`	number	<optional>	1

Source: src/engineUtilities.js, line 440

Returns:

Type:: Vector2

copy() → {Vector2}

Returns a new vector that is a copy of this

Source: src/engineUtilities.js, line 355

Returns:

Type:: Vector2

cross(v) → {number}

Returns the cross product of this and the vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector

Source: src/engineUtilities.js, line 458

Returns:

Type:: number

direction() → {number}

Returns the integer direction of this vector, corresponding to multiples of 90 degree rotation (0-3)

Source: src/engineUtilities.js, line 501

Returns:

Type:: number

distance(v) → {number}

Returns the distance from this vector to vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector

Source: src/engineUtilities.js, line 413

Returns:

Type:: number

distanceSquared(v) → {number}

Returns the distance squared from this vector to vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector

Source: src/engineUtilities.js, line 422

Returns:

Type:: number

divide(v) → {Vector2}

Returns a copy of this vector divided by the vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector

Source: src/engineUtilities.js, line 387

Returns:

Type:: Vector2

dot(v) → {number}

Returns the dot product of this and the vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector

Source: src/engineUtilities.js, line 449

Returns:

Type:: number

floor() → {Vector2}

Returns a copy of this vector with each axis floored

Source: src/engineUtilities.js, line 510

Returns:

Type:: Vector2

invert() → {Vector2}

Returns a copy of this vector that has been inverted

Source: src/engineUtilities.js, line 506

Returns:

Type:: Vector2

isValid() → {boolean}

Checks if this is a valid vector

Source: src/engineUtilities.js, line 546

Returns:

Type:: boolean

length() → {number}

Returns the length of this vector

Source: src/engineUtilities.js, line 404

Returns:

Type:: number

lengthSquared() → {number}

Returns the length of this vector squared

Source: src/engineUtilities.js, line 408

Returns:

Type:: number

lerp(v, percent) → {Vector2}

Returns a new vector that is p percent between this and the vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector
`percent`	number

Source: src/engineUtilities.js, line 520

Returns:

Type:: Vector2

multiply(v) → {Vector2}

Returns a copy of this vector times the vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector

Source: src/engineUtilities.js, line 378

Returns:

Type:: Vector2

normalize(lengthopt) → {Vector2}

Returns a new vector in same direction as this one with the length passed in

Parameters:

Name	Type	Attributes	Default	Description
`length`	number	<optional>	1

Source: src/engineUtilities.js, line 431

Returns:

Type:: Vector2

rotate(angle) → {Vector2}

Returns copy of this vector rotated by the clockwise angle passed in

Parameters:

Name	Type	Description
`angle`	number

Source: src/engineUtilities.js, line 482

Returns:

Type:: Vector2

scale(s) → {Vector2}

Returns a copy of this vector scaled by the vector passed in

Parameters:

Name	Type	Description
`s`	number	scale

Source: src/engineUtilities.js, line 396

Returns:

Type:: Vector2

set(xopt, yopt) → {Vector2}

Sets values of this vector and returns self

Parameters:

Name	Type	Attributes	Default	Description
`x`	number	<optional>	0	X axis location
`y`	number	<optional>	0	Y axis location

Source: src/engineUtilities.js, line 345

Returns:

Type:: Vector2

setAngle(angleopt, lengthopt) → {Vector2}

Sets this vector with clockwise angle and length passed in

Parameters:

Name	Type	Attributes	Default	Description
`angle`	number	<optional>	0
`length`	number	<optional>	1

Source: src/engineUtilities.js, line 472

Returns:

Type:: Vector2

setDirection(directionopt, lengthopt)

Set the integer direction of this vector, corresponding to multiples of 90 degree rotation (0-3)

Parameters:

Name	Type	Attributes	Default	Description
`direction`	number	<optional>
`length`	number	<optional>	1

Source: src/engineUtilities.js, line 491

subtract(v) → {Vector2}

Returns a copy of this vector minus the vector passed in

Parameters:

Name	Type	Description
`v`	Vector2	other vector

Source: src/engineUtilities.js, line 369

Returns:

Type:: Vector2

toString(digits) → {string}

Returns this vector expressed as a string

Parameters:

Name	Type	Default	Description
`digits`	number	3	precision to display

Source: src/engineUtilities.js, line 538

Returns:

Type:: string