Class: Vec2

pc.Vec2

A 2-dimensional vector.

Constructor

new Vec2(xopt, yopt)

Creates a new Vec2 object.
Parameters:
Name Type Attributes Description
x Number <optional>
The x value. If x is an array of length 2, the array will be used to populate all components.
y Number <optional>
The y value.
Source:
Example
var v = new pc.Vec2(1, 2);

Members

x :Number

The first element of the vector.
Type:
  • Number
Source:
Example
var vec = new pc.Vec2(10, 20);

// Get x
var x = vec.x;

// Set x
vec.x = 0;

y :Number

The second element of the vector.
Type:
  • Number
Source:
Example
var vec = new pc.Vec2(10, 20);

// Get y
var y = vec.y;

// Set y
vec.y = 0;

(static, readonly) ONE :pc.Vec2

A constant vector set to [1, 1].
Type:
Source:

(static, readonly) RIGHT :pc.Vec2

A constant vector set to [1, 0].
Type:
Source:

(static, readonly) UP :pc.Vec2

A constant vector set to [0, 1].
Type:
Source:

(static, readonly) ZERO :pc.Vec2

A constant vector set to [0, 0].
Type:
Source:

Methods

add(rhs) → {pc.Vec2}

Adds a 2-dimensional vector to another in place.
Parameters:
Name Type Description
rhs pc.Vec2 The vector to add to the specified vector.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var a = new pc.Vec2(10, 10);
var b = new pc.Vec2(20, 20);

a.add(b);

// Should output [30, 30]
console.log("The result of the addition is: " + a.toString());

add2(lhs, rhs) → {pc.Vec2}

Adds two 2-dimensional vectors together and returns the result.
Parameters:
Name Type Description
lhs pc.Vec2 The first vector operand for the addition.
rhs pc.Vec2 The second vector operand for the addition.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var a = new pc.Vec2(10, 10);
var b = new pc.Vec2(20, 20);
var r = new pc.Vec2();

r.add2(a, b);
// Should output [30, 30]

console.log("The result of the addition is: " + r.toString());

clone() → {pc.Vec2}

Returns an identical copy of the specified 2-dimensional vector.
Source:
Returns:
A 2-dimensional vector containing the result of the cloning.
Type
pc.Vec2
Example
var v = new pc.Vec2(10, 20);
var vclone = v.clone();
console.log("The result of the cloning is: " + vclone.toString());

copy(rhs) → {pc.Vec2}

Copied the contents of a source 2-dimensional vector to a destination 2-dimensional vector.
Parameters:
Name Type Description
rhs pc.Vec2 A vector to copy to the specified vector.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var src = new pc.Vec2(10, 20);
var dst = new pc.Vec2();

dst.copy(src);

console.log("The two vectors are " + (dst.equals(src) ? "equal" : "different"));

dot(rhs) → {Number}

Returns the result of a dot product operation performed on the two specified 2-dimensional vectors.
Parameters:
Name Type Description
rhs pc.Vec2 The second 2-dimensional vector operand of the dot product.
Source:
Returns:
The result of the dot product operation.
Type
Number
Example
var v1 = new pc.Vec2(5, 10);
var v2 = new pc.Vec2(10, 20);
var v1dotv2 = v1.dot(v2);
console.log("The result of the dot product is: " + v1dotv2);

equals(rhs) → {Boolean}

Reports whether two vectors are equal.
Parameters:
Name Type Description
rhs pc.Vec2 The vector to compare to the specified vector.
Source:
Returns:
true if the vectors are equal and false otherwise.
Type
Boolean
Example
var a = new pc.Vec2(1, 2);
var b = new pc.Vec2(4, 5);
console.log("The two vectors are " + (a.equals(b) ? "equal" : "different"));

length() → {Number}

Returns the magnitude of the specified 2-dimensional vector.
Source:
Returns:
The magnitude of the specified 2-dimensional vector.
Type
Number
Example
var vec = new pc.Vec2(3, 4);
var len = vec.length();
// Should output 5
console.log("The length of the vector is: " + len);

lengthSq() → {Number}

Returns the magnitude squared of the specified 2-dimensional vector.
Source:
Returns:
The magnitude of the specified 2-dimensional vector.
Type
Number
Example
var vec = new pc.Vec2(3, 4);
var len = vec.lengthSq();
// Should output 25
console.log("The length squared of the vector is: " + len);

lerp(lhs, rhs, alpha) → {pc.Vec2}

Returns the result of a linear interpolation between two specified 2-dimensional vectors.
Parameters:
Name Type Description
lhs pc.Vec2 The 2-dimensional to interpolate from.
rhs pc.Vec2 The 2-dimensional to interpolate to.
alpha Number The value controlling the point of interpolation. Between 0 and 1, the linear interpolant will occur on a straight line between lhs and rhs. Outside of this range, the linear interpolant will occur on a ray extrapolated from this line.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var a = new pc.Vec2(0, 0);
var b = new pc.Vec2(10, 10);
var r = new pc.Vec2();

r.lerp(a, b, 0);   // r is equal to a
r.lerp(a, b, 0.5); // r is 5, 5
r.lerp(a, b, 1);   // r is equal to b

mul(rhs) → {pc.Vec2}

Multiplies a 2-dimensional vector to another in place.
Parameters:
Name Type Description
rhs pc.Vec2 The 2-dimensional vector used as the second multiplicand of the operation.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var a = new pc.Vec2(2, 3);
var b = new pc.Vec2(4, 5);

a.mul(b);

// Should output 8, 15
console.log("The result of the multiplication is: " + a.toString());

mul2(lhs, rhs) → {pc.Vec2}

Returns the result of multiplying the specified 2-dimensional vectors together.
Parameters:
Name Type Description
lhs pc.Vec2 The 2-dimensional vector used as the first multiplicand of the operation.
rhs pc.Vec2 The 2-dimensional vector used as the second multiplicand of the operation.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var a = new pc.Vec2(2, 3);
var b = new pc.Vec2(4, 5);
var r = new pc.Vec2();

r.mul2(a, b);

// Should output 8, 15
console.log("The result of the multiplication is: " + r.toString());

normalize() → {pc.Vec2}

Returns the specified 2-dimensional vector copied and converted to a unit vector. If the vector has a length of zero, the vector's elements will be set to zero.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var v = new pc.Vec2(25, 0);

v.normalize();

// Should output 1, 0
console.log("The result of the vector normalization is: " + v.toString());

scale(scalar) → {pc.Vec2}

Scales each component of the specified 2-dimensional vector by the supplied scalar value.
Parameters:
Name Type Description
scalar Number The value by which each vector component is multiplied.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var v = new pc.Vec2(2, 4);

// Multiply by 2
v.scale(2);

// Negate
v.scale(-1);

// Divide by 2
v.scale(0.5);

set(x, y) → {pc.Vec2}

Sets the specified 2-dimensional vector to the supplied numerical values.
Parameters:
Name Type Description
x Number The value to set on the first component of the vector.
y Number The value to set on the second component of the vector.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var v = new pc.Vec2();
v.set(5, 10);

// Should output 5, 10
console.log("The result of the vector set is: " + v.toString());

sub(rhs) → {pc.Vec2}

Subtracts a 2-dimensional vector from another in place.
Parameters:
Name Type Description
rhs pc.Vec2 The vector to add to the specified vector.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var a = new pc.Vec2(10, 10);
var b = new pc.Vec2(20, 20);

a.sub(b);

// Should output [-10, -10]
console.log("The result of the addition is: " + a.toString());

sub2(lhs, rhs) → {pc.Vec2}

Subtracts two 2-dimensional vectors from one another and returns the result.
Parameters:
Name Type Description
lhs pc.Vec2 The first vector operand for the addition.
rhs pc.Vec2 The second vector operand for the addition.
Source:
Returns:
Self for chaining.
Type
pc.Vec2
Example
var a = new pc.Vec2(10, 10);
var b = new pc.Vec2(20, 20);
var r = new pc.Vec2();

r.sub2(a, b);

// Should output [-10, -10]
console.log("The result of the addition is: " + r.toString());

toString() → {String}

Converts the vector to string form.
Source:
Returns:
The vector in string form.
Type
String
Example
var v = new pc.Vec2(20, 10);
// Should output '[20, 10]'
console.log(v.toString());