Class: Vector3

Constructor

new Vector3(xopt, yopt, zopt)

Create a 3D vector

Parameters:

Name	Type	Attributes
`x`	number	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: plugins/math3d.js, line 75

Example

const a = vec3(1, 2, 3);
const b = a.add(vec3(0, 1, 0)).normalize();

Members

x

Properties

Type	Description
number	X axis location

Source: plugins/math3d.js, line 85

y

Properties

Type	Description
number	Y axis location

Source: plugins/math3d.js, line 87

z

Properties

Type	Description
number	Z axis location

Source: plugins/math3d.js, line 89

Methods

abs() → {Vector3}

Returns a new vector with the absolute value of each component

Source: plugins/math3d.js, line 242

Returns:

Type:: Vector3

add(v) → {Vector3}

Returns a copy of this vector plus the vector passed in

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 111

Returns:

Type:: Vector3

clampLength(lengthopt) → {Vector3}

Returns a new vector clamped to the length passed in

Parameters:

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

Source: plugins/math3d.js, line 169

Returns:

Type:: Vector3

copy() → {Vector3}

Returns a new vector that is a copy of this

Source: plugins/math3d.js, line 106

Returns:

Type:: Vector3

cross(v) → {Vector3}

Returns a vector at right angles to both this and the one passed in

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 183

Returns:

Type:: Vector3

distance(v) → {number}

Returns the distance from this vector to the vector passed in

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 150

Returns:

Type:: number

distanceSquared(v) → {number}

Returns the distance squared from this vector to the vector passed in

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 155

Returns:

Type:: number

divide(v) → {Vector3}

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

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 126

Returns:

Type:: Vector3

dot(v) → {number}

Returns the dot product of this vector and the vector passed in

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 178

Returns:

Type:: number

floor() → {Vector3}

Returns a new vector with each component floored

Source: plugins/math3d.js, line 246

Returns:

Type:: Vector3

isValid() → {boolean}

Checks if this is a valid vector

Source: plugins/math3d.js, line 273

Returns:

Type:: boolean

length() → {number}

Returns the length of this vector

Source: plugins/math3d.js, line 135

Returns:

Type:: number

lengthSquared() → {number}

Returns the length of this vector squared

Source: plugins/math3d.js, line 139

Returns:

Type:: number

lerp(v, percent) → {Vector3}

Returns a new vector interpolated between this and the vector passed in, percent is clamped to 0-1

Parameters:

Name	Type	Description
`v`	Vector3
`percent`	number

Source: plugins/math3d.js, line 195

Returns:

Type:: Vector3

multiply(v) → {Vector3}

Returns a copy of this vector times the vector passed in

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 121

Returns:

Type:: Vector3

normalize(lengthopt) → {Vector3}

Returns a new vector in the same direction with the length passed in, zero stays zero

Parameters:

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

Source: plugins/math3d.js, line 160

Returns:

Type:: Vector3

reflect(normal, restitutionopt) → {Vector3}

Returns a copy of this vector reflected by a surface normal

Parameters:

Name	Type	Attributes	Default	Description
`normal`	Vector3			Surface normal, should be normalized
`restitution`	number	<optional>	1	How much to bounce, 1 is a perfect bounce, 0 slides along the surface

Source: plugins/math3d.js, line 145

Returns:

Type:: Vector3

rotate(axis, angle) → {Vector3}

Returns a new vector turned around an axis, counter clockwise when the axis points at you

Parameters:

Name	Type	Description
`axis`	Vector3	Unit length
`angle`	number	Radians

Source: plugins/math3d.js, line 205

Returns:

Type:: Vector3

rotateX(angle) → {Vector3}

Returns a new vector turned around the X axis, the way a positive pitch in rotation3D turns things

Parameters:

Name	Type	Description
`angle`	number	Radians

Source: plugins/math3d.js, line 216

Returns:

Type:: Vector3

rotateY(angle) → {Vector3}

Returns a new vector turned around the Y axis, the way a positive yaw in rotation3D turns things

Parameters:

Name	Type	Description
`angle`	number	Radians

Source: plugins/math3d.js, line 225

Returns:

Type:: Vector3

rotateZ(angle) → {Vector3}

Returns a new vector turned around the Z axis, the way a positive roll in rotation3D turns things

Parameters:

Name	Type	Description
`angle`	number	Radians

Source: plugins/math3d.js, line 234

Returns:

Type:: Vector3

round() → {Vector3}

Returns a new vector with each component rounded

Source: plugins/math3d.js, line 250

Returns:

Type:: Vector3

scale(s) → {Vector3}

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

Parameters:

Name	Type	Description
`s`	number

Source: plugins/math3d.js, line 131

Returns:

Type:: Vector3

set(xopt, yopt, zopt) → {Vector3}

Sets values of this vector and returns self

Parameters:

Name	Type	Attributes
`x`	number	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: plugins/math3d.js, line 97

Returns:

Type:: Vector3

setFrom(v) → {Vector3}

Copies the values of another vector into this one and returns self

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 102

Returns:

Type:: Vector3

snap(grid) → {Vector3}

Returns a new vector snapped down to a grid, grid is the number of steps per unit like Vector2.snap

Parameters:

Name	Type	Description
`grid`	number	Snap steps per unit, 2 snaps to halves

Source: plugins/math3d.js, line 255

Returns:

Type:: Vector3

subtract(v) → {Vector3}

Returns a copy of this vector minus the vector passed in

Parameters:

Name	Type	Description
`v`	Vector3

Source: plugins/math3d.js, line 116

Returns:

Type:: Vector3

toString(digitsopt) → {string}

Returns a string representation of this vector for debugging

Parameters:

Name	Type	Attributes	Default	Description
`digits`	number	<optional>	3	Number of digits to display

Source: plugins/math3d.js, line 278

Returns:

Type:: string

transform(matrix) → {Vector3}

Returns this point transformed by a matrix, translation included

Parameters:

Name	Type	Description
`matrix`	Matrix4

Source: plugins/math3d.js, line 264

Returns:

Type:: Vector3

transformDirection(matrix) → {Vector3}

Returns this direction transformed by a matrix, rotation and scale only

Parameters:

Name	Type	Description
`matrix`	Matrix4

Source: plugins/math3d.js, line 269

Returns:

Type:: Vector3