Class: Vector

Constructor

new Vector(parametersopt)

Creates a new Vector instance.

Parameters:

Name Type Attributes Description

parameters

Object

The parameters for the vector.

Properties

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

Source: math/vector.js, line 9

Members

NEGATIVE_X

The NEGATIVE_X vector is a unit vector pointing in the negative x direction.

Source: math/vector.js, line 245

NEGATIVE_Y

The NEGATIVE_Y vector is a unit vector pointing in the negative y direction.

Source: math/vector.js, line 257

NEGATIVE_Z

The NEGATIVE_Z vector is a unit vector pointing in the negative z direction.

Source: math/vector.js, line 269

X

The X vector is a unit vector pointing in the positive x direction.

Source: math/vector.js, line 239

Y

The Y vector is a unit vector pointing in the positive y direction.

Source: math/vector.js, line 251

Z

The Z vector is a unit vector pointing in the positive z direction.

Source: math/vector.js, line 263

ZERO

The ZERO vector is an empty vector.

Source: math/vector.js, line 233

length

Gets the length (magnitude) of this vector.

Source: math/vector.js, line 81

x

Gets the X component of this vector.

Source: math/vector.js, line 38

x

Sets the X component of this vector.

Source: math/vector.js, line 59

y

Gets the Y component of this vector.

Source: math/vector.js, line 45

y

Sets the Y component of this vector.

Source: math/vector.js, line 66

z

Gets the Z component of this vector.

Source: math/vector.js, line 52

z

Sets the Z component of this vector.

Source: math/vector.js, line 73

Methods

add(other) → {Vector}

Adds another vector to this vector.

Parameters:

Name	Type	Description
`other`	Vector	The vector to add.

Source: math/vector.js, line 90

Returns:

A new Vector representing the result.

Type:: Vector

angle(other) → {number}

Computes the angle between this vector and another vector.

Parameters:

Name	Type	Description
`other`	Vector	The other vector.

Source: math/vector.js, line 190

Returns:

The angle between the vectors in radians.

Type:: number

cross(other) → {Vector}

Computes the cross product of this vector with another vector.

Parameters:

Name	Type	Description
`other`	Vector	The other vector.

Source: math/vector.js, line 126

Returns:

A new Vector representing the result.

Type:: Vector

distance(other) → {number}

Computes the distance between this vector and another vector.

Parameters:

Name	Type	Description
`other`	Vector	The other vector.

Source: math/vector.js, line 181

Returns:

The distance between the vectors.

Type:: number

divide(scalar) → {Vector}

Divides this vector by a scalar.

Parameters:

Name	Type	Description
`scalar`	number	The scalar to divide by.

Source: math/vector.js, line 117

Returns:

A new Vector representing the result.

Type:: Vector

dot(other) → {number}

Computes the dot product of this vector with another vector.

Parameters:

Name	Type	Description
`other`	Vector	The other vector.

Source: math/vector.js, line 135

Returns:

The dot product of the two vectors.

Type:: number

isEqual(other) → {boolean}

Checks if this vector is equal to another vector.

Parameters:

Name	Type	Description
`other`	Vector	The other vector.

Source: math/vector.js, line 207

Returns:

true if the vectors are equal, false otherwise.

Type:: boolean

isParallel(other) → {boolean}

Checks if this vector is parallel to another vector.

Parameters:

Name	Type	Description
`other`	Vector	The other vector.

Source: math/vector.js, line 225

Returns:

true if the vectors are parallel, false otherwise.

Type:: boolean

isPerpendicular(other) → {boolean}

Checks if this vector is perpendicular (normal) to another vector.

Parameters:

Name	Type	Description
`other`	Vector	The other vector.

Source: math/vector.js, line 216

Returns:

true if the vectors are perpendicular, false otherwise.

Type:: boolean

mirror(plane) → {Vector}

Mirrors this vector across a specified plane.

Parameters:

Name	Type	Description
`plane`	Plane	The plane to mirror across.

Source: math/vector.js, line 172

Returns:

A new Vector representing the mirrored result.

Type:: Vector

multiply(scalar) → {Vector}

Multiplies this vector by a scalar.

Parameters:

Name	Type	Description
`scalar`	number	The scalar to multiply by.

Source: math/vector.js, line 108

Returns:

A new Vector representing the result.

Type:: Vector

normalize() → {Vector}

Normalizes this vector to have a length of 1.

Source: math/vector.js, line 198

Returns:

A new Vector representing the result.

Type:: Vector

rotate(parameters) → {Vector}

Rotates this vector around a specified axis by a given angle.

Parameters:

Name Type Description

parameters

Object

Rotation parameters.

Properties

Name	Type	Description
`axis`	Axis	The axis to rotate around.
`angle`	number	The rotation angle in radians.

Source: math/vector.js, line 146

Returns:

A new Vector representing the result.

Type:: Vector

scale(scalar) → {Vector}

Scales this vector by a scalar.

Parameters:

Name	Type	Description
`scalar`	number	The scaling factor.

Source: math/vector.js, line 163

Returns:

A new Vector representing the result.

Type:: Vector

subtract(other) → {Vector}

Subtracts another vector from this vector.

Parameters:

Name	Type	Description
`other`	Vector	The vector to subtract.

Source: math/vector.js, line 99

Returns:

A new Vector representing the result.

Type:: Vector