const v = new pc.Vec3(1, 2, 3);

Vec3([x], [y], [z]) 

Creates a new Vec3 object.

const v = new pc.Vec3(1, 2, 3);

Parameters

x	number, number[]	The x value. Defaults to 0. If x is an array of length 3, the array will be used to populate all components.
y	number	The y value. Defaults to 0.
z	number	The z value. Defaults to 0.

numberx 

The first component of the vector.

numbery 

The second component of the vector.

numberz 

The third component of the vector.

add(rhs) 

Adds a 3-dimensional vector to another in place.

const a = new pc.Vec3(10, 10, 10);
const b = new pc.Vec3(20, 20, 20);

a.add(b);

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

Parameters

rhs

Vec3

The vector to add to the specified vector.

Returns

Vec3

Self for chaining.

add2(lhs, rhs) 

Adds two 3-dimensional vectors together and returns the result.

const a = new pc.Vec3(10, 10, 10);
const b = new pc.Vec3(20, 20, 20);
const r = new pc.Vec3();

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

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

Parameters

lhs	Vec3	The first vector operand for the addition.
rhs	Vec3	The second vector operand for the addition.

Returns

Vec3

Self for chaining.

addScalar(scalar) 

Adds a number to each element of a vector.

const vec = new pc.Vec3(3, 4, 5);

vec.addScalar(2);

// Outputs [5, 6, 7]
console.log("The result of the addition is: " + vec.toString());

Parameters

scalar

number

The number to add.

Returns

Vec3

Self for chaining.

ceil() 

Each element is rounded up to the next largest integer.

Returns

Vec3

Self for chaining.

clone() 

Returns an identical copy of the specified 3-dimensional vector.

const v = new pc.Vec3(10, 20, 30);
const vclone = v.clone();
console.log("The result of the cloning is: " + vclone.toString());

Returns

this

A 3-dimensional vector containing the result of the cloning.

copy(rhs) 

Copies the contents of a source 3-dimensional vector to a destination 3-dimensional vector.

const src = new pc.Vec3(10, 20, 30);
const dst = new pc.Vec3();

dst.copy(src);

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

Parameters

rhs

Vec3

A vector to copy to the specified vector.

Returns

Vec3

Self for chaining.

cross(lhs, rhs) 

Returns the result of a cross product operation performed on the two specified 3-dimensional vectors.

const back = new pc.Vec3().cross(pc.Vec3.RIGHT, pc.Vec3.UP);

// Prints the Z axis (i.e. [0, 0, 1])
console.log("The result of the cross product is: " + back.toString());

Parameters

lhs	Vec3	The first 3-dimensional vector operand of the cross product.
rhs	Vec3	The second 3-dimensional vector operand of the cross product.

Returns

Vec3

Self for chaining.

distance(rhs) 

Returns the distance between the two specified 3-dimensional vectors.

const v1 = new pc.Vec3(5, 10, 20);
const v2 = new pc.Vec3(10, 20, 40);
const d = v1.distance(v2);
console.log("The distance between v1 and v2 is: " + d);

Parameters

rhs

Vec3

The second 3-dimensional vector to test.

Returns

number

The distance between the two vectors.

div(rhs) 

Divides a 3-dimensional vector by another in place.

const a = new pc.Vec3(4, 9, 16);
const b = new pc.Vec3(2, 3, 4);

a.div(b);

// Outputs [2, 3, 4]
console.log("The result of the division is: " + a.toString());

Parameters

rhs

Vec3

The vector to divide the specified vector by.

Returns

Vec3

Self for chaining.

div2(lhs, rhs) 

Divides one 3-dimensional vector by another and writes the result to the specified vector.

const a = new pc.Vec3(4, 9, 16);
const b = new pc.Vec3(2, 3, 4);
const r = new pc.Vec3();

r.div2(a, b);
// Outputs [2, 3, 4]

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

Parameters

lhs	Vec3	The dividend vector (the vector being divided).
rhs	Vec3	The divisor vector (the vector dividing the dividend).

Returns

Vec3

Self for chaining.

divScalar(scalar) 

Divides each element of a vector by a number.

const vec = new pc.Vec3(3, 6, 9);

vec.divScalar(3);

// Outputs [1, 2, 3]
console.log("The result of the division is: " + vec.toString());

Parameters

scalar

number

The number to divide by.

Returns

Vec3

Self for chaining.

dot(rhs) 

Returns the result of a dot product operation performed on the two specified 3-dimensional vectors.

const v1 = new pc.Vec3(5, 10, 20);
const v2 = new pc.Vec3(10, 20, 40);
const v1dotv2 = v1.dot(v2);
console.log("The result of the dot product is: " + v1dotv2);

Parameters

rhs

Vec3

The second 3-dimensional vector operand of the dot product.

Returns

number

The result of the dot product operation.

equals(rhs) 

Reports whether two vectors are equal.

const a = new pc.Vec3(1, 2, 3);
const b = new pc.Vec3(4, 5, 6);
console.log("The two vectors are " + (a.equals(b) ? "equal" : "different"));

Parameters

rhs

Vec3

The vector to compare to the specified vector.

Returns

boolean

True if the vectors are equal and false otherwise.

floor() 

Each element is set to the largest integer less than or equal to its value.

Returns

Vec3

Self for chaining.

length() 

Returns the magnitude of the specified 3-dimensional vector.

const vec = new pc.Vec3(3, 4, 0);
const len = vec.length();
// Outputs 5
console.log("The length of the vector is: " + len);

Returns

number

The magnitude of the specified 3-dimensional vector.

lengthSq() 

Returns the magnitude squared of the specified 3-dimensional vector.

const vec = new pc.Vec3(3, 4, 0);
const len = vec.lengthSq();
// Outputs 25
console.log("The length squared of the vector is: " + len);

Returns

number

The magnitude of the specified 3-dimensional vector.

lerp(lhs, rhs, alpha) 

Returns the result of a linear interpolation between two specified 3-dimensional vectors.

const a = new pc.Vec3(0, 0, 0);
const b = new pc.Vec3(10, 10, 10);
const r = new pc.Vec3();

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

Parameters

lhs	Vec3	The 3-dimensional to interpolate from.
rhs	Vec3	The 3-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.

Returns

Vec3

Self for chaining.

max(rhs) 

Each element is assigned a value from rhs parameter if it is larger.

Parameters

rhs

Vec3

The 3-dimensional vector used as the source of elements to compare to.

Returns

Vec3

Self for chaining.

min(rhs) 

Each element is assigned a value from rhs parameter if it is smaller.

Parameters

rhs

Vec3

The 3-dimensional vector used as the source of elements to compare to.

Returns

Vec3

Self for chaining.

mul(rhs) 

Multiplies a 3-dimensional vector to another in place.

const a = new pc.Vec3(2, 3, 4);
const b = new pc.Vec3(4, 5, 6);

a.mul(b);

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

Parameters

rhs

Vec3

The 3-dimensional vector used as the second multiplicand of the operation.

Returns

Vec3

Self for chaining.

mul2(lhs, rhs) 

Returns the result of multiplying the specified 3-dimensional vectors together.

const a = new pc.Vec3(2, 3, 4);
const b = new pc.Vec3(4, 5, 6);
const r = new pc.Vec3();

r.mul2(a, b);

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

Parameters

lhs	Vec3	The 3-dimensional vector used as the first multiplicand of the operation.
rhs	Vec3	The 3-dimensional vector used as the second multiplicand of the operation.

Returns

Vec3

Self for chaining.

mulScalar(scalar) 

Multiplies each element of a vector by a number.

const vec = new pc.Vec3(3, 6, 9);

vec.mulScalar(3);

// Outputs [9, 18, 27]
console.log("The result of the multiplication is: " + vec.toString());

Parameters

scalar

number

The number to multiply by.

Returns

Vec3

Self for chaining.

normalize() 

Returns this 3-dimensional vector converted to a unit vector in place. If the vector has a length of zero, the vector's elements will be set to zero.

const v = new pc.Vec3(25, 0, 0);

v.normalize();

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

Returns

Vec3

Self for chaining.

project(rhs) 

Projects this 3-dimensional vector onto the specified vector.

const v = new pc.Vec3(5, 5, 5);
const normal = new pc.Vec3(1, 0, 0);

v.project(normal);

// Outputs 5, 0, 0
console.log("The result of the vector projection is: " + v.toString());

Parameters

rhs

Vec3

The vector onto which the original vector will be projected on.

Returns

Vec3

Self for chaining.

round() 

Each element is rounded up or down to the nearest integer.

Returns

Vec3

Self for chaining.

set(x, y, z) 

Sets the specified 3-dimensional vector to the supplied numerical values.

const v = new pc.Vec3();
v.set(5, 10, 20);

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

Parameters

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.
z	number	The value to set on the third component of the vector.

Returns

Vec3

Self for chaining.

sub(rhs) 

Subtracts a 3-dimensional vector from another in place.

const a = new pc.Vec3(10, 10, 10);
const b = new pc.Vec3(20, 20, 20);

a.sub(b);

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

Parameters

rhs

Vec3

The vector to subtract from the specified vector.

Returns

Vec3

Self for chaining.

sub2(lhs, rhs) 

Subtracts two 3-dimensional vectors from one another and returns the result.

const a = new pc.Vec3(10, 10, 10);
const b = new pc.Vec3(20, 20, 20);
const r = new pc.Vec3();

r.sub2(a, b);

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

Parameters

lhs	Vec3	The first vector operand for the subtraction.
rhs	Vec3	The second vector operand for the subtraction.

Returns

Vec3

Self for chaining.

subScalar(scalar) 

Subtracts a number from each element of a vector.

const vec = new pc.Vec3(3, 4, 5);

vec.subScalar(2);

// Outputs [1, 2, 3]
console.log("The result of the subtraction is: " + vec.toString());

Parameters

scalar

number

The number to subtract.

Returns

Vec3

Self for chaining.

toString() 

Converts the vector to string form.

const v = new pc.Vec3(20, 10, 5);
// Outputs [20, 10, 5]
console.log(v.toString());

Returns

string

The vector in string form.