Class: Vector3D

Constructor

new Vector3D(x, y, z)

Parameters:

Name	Type	Description
`x`	number	The X component of the vector.
`y`	number	The Y component of the vector.
`z`	number	The Z component of the vector.

Source: src/math/vector.js, line 4

Classes

Vector3D

Methods

crossProduct(vector3D) → {Vector3D}

Get the cross product with another Vector3D, ie the vector that is perpendicular to both a and b. If both vectors are parallel, the cross product is a zero vector.

Ref: https://en.wikipedia.org/wiki/Cross_product.

Parameters:

Name	Type	Description
`vector3D`	Vector3D	The input vector.

Source: src/math/vector.js, line 112

Returns:

The result vector.

Type:: Vector3D

dotProduct(vector3D) → {number}

Get the dot product with another Vector3D.

Ref: https://en.wikipedia.org/wiki/Dot_product.

Parameters:

Name	Type	Description
`vector3D`	Vector3D	The input vector.

Source: src/math/vector.js, line 127

Returns:

The dot product.

Type:: number

equals(rhs) → {boolean}

Check for Vector3D equality.

Parameters:

Name	Type	Description
`rhs`	Vector3D	The other vector to compare to.

Source: src/math/vector.js, line 71

Returns:

True if both vectors are equal.

Type:: boolean

getX() → {number}

Get the X component of the vector.

Source: src/math/vector.js, line 43

Returns:

The X component of the vector.

Type:: number

getY() → {number}

Get the Y component of the vector.

Source: src/math/vector.js, line 52

Returns:

The Y component of the vector.

Type:: number

getZ() → {number}

Get the Z component of the vector.

Source: src/math/vector.js, line 61

Returns:

The Z component of the vector.

Type:: number

isCodirectional(vector3D) → {boolean}

Is this vector codirectional to an input one.

Parameters:

Name	Type	Description
`vector3D`	Vector3D	The vector to test.

Source: src/math/vector.js, line 139

Returns:

True if codirectional, false is opposite.

Type:: boolean

norm() → {number}

Get the norm of the vector.

Source: src/math/vector.js, line 94

Returns:

The norm.

Type:: number

toString() → {string}

Get a string representation of the Vector3D.

Source: src/math/vector.js, line 83

Returns:

The vector as a string.

Type:: string