Class Vector3

This class holds the x,y,z components of a 3D point or vector. It includes linear algebra routines for working with vectors (e.g., dot product, cross product).

Most of the functions in the class are defined both as member functions that can be called on a specific instance of Vector3 and as static functions. The static functions return a new result, leaving the original inputs unchanged, whereas, in general, member functions save the result in this vector itself and return void:

const v = new Vector3(1, 2, 3);
const w = new Vector3(4, 5, 6);

// saves the result in n, v and w are unchanged.
const n = Vector3.cross(v, w);

// saves the result in v and returns null.  v now becomes v crossed-with w.
v.cross(w);

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
Constructs a Vector3 object from x, y, and z values
Parameters
- x: number = 0
  The x value for the Vector3
- y: number = 0
  The y value for the Vector3
- z: number = 0
  The z value for the Vector3
Returns Vector3
- Defined in math/Vector3.ts:380

Properties

x

x: number

y

y: number

z

z: number

`Static` `Readonly`BACK

BACK: Vector3 = ...

A Vector3 object that points backward. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`DOWN

DOWN: Vector3 = ...

A Vector3 object that points down. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`FORWARD

FORWARD: Vector3 = ...

A Vector3 object that points forward. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`LEFT

LEFT: Vector3 = ...

A Vector3 object that points left. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`ONE

ONE: Vector3 = ...

A Vector3 object with all one values. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`RIGHT

RIGHT: Vector3 = ...

A Vector3 object that points right. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`UP

UP: Vector3 = ...

A Vector3 object that points up. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`X_AXIS

X_AXIS: Vector3 = Vector3.RIGHT

A Vector3 object that points along the x-axis. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`Y_AXIS

Y_AXIS: Vector3 = Vector3.UP

A Vector3 object that points along the y-axis. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`Z_AXIS

Z_AXIS: Vector3 = Vector3.FORWARD

A Vector3 object that points along the z-axis. (See note in the Vector3.ZERO docs for important usage info.)

`Static` `Readonly`ZERO

ZERO: Vector3 = ...

A static property to provide quick access to a Vector3 with all of its x,y,z components equal to zero.

Methods

add

add(v: Vector3): void
Adds the given Vector3 to this Vector3
Parameters
- v: Vector3
  The Vector3 object to add
Returns void
- Defined in math/Vector3.ts:452

angleBetween

angleBetween(v: Vector3): number
Computes the angle between this Vector3 and another Vector3
Parameters
- v: Vector3
  The second Vector3
Returns number
The angle between the two Vectors
- Defined in math/Vector3.ts:651

clone

clone(): Vector3
Creates a new Vector3 object with the same x, y, and z values as this Vector3

Returns Vector3
The cloned Vector3 object
- Defined in math/Vector3.ts:418

copy

copy(v: Vector3): void
Copies a Vector3 object
Parameters
- v: Vector3
  The Vector3 object to copy
Returns void
- Defined in math/Vector3.ts:406

cross

cross(v: Vector3): void
Computes the cross product of two Vector3s and stores the result in the original Vector3.
Parameters
- v: Vector3
  The Vector3 to compute the cross product with.
Returns void
- Defined in math/Vector3.ts:511

distanceTo

distanceTo(v: Vector3): number
Computes the distance between this Vector3 and another Vector3
Parameters
- v: Vector3
  The second Vector3
Returns number
The distance between the two Vectors
- Defined in math/Vector3.ts:665

divide

divide(v: Vector3): void
Divides each component of the vector with that of another vector
Parameters
- v: Vector3
  Vector to divide with
Returns void
- Defined in math/Vector3.ts:488

divideScalar

divideScalar(n: number): void
Divides each component of the vector with a scalar value
Parameters
- n: number
  Scalar value to divide with
Returns void
- Defined in math/Vector3.ts:538

dot

dot(v: Vector3): number
Compute the dot product of two Vector3 objects
Parameters
- v: Vector3
  The other Vector3 object
Returns number
The dot product of the two Vector3 objects
- Defined in math/Vector3.ts:501

equals

equals(v: Vector3): boolean
Checks if the x,y,z components of this Vector3 are exactly equal to those of the given Vector3
Parameters
- v: Vector3
  The Vector3 object to compare to
Returns boolean
A boolean value indicating if the Vector3 objects are equal
- Defined in math/Vector3.ts:429

fuzzyEquals

fuzzyEquals(v: Vector3, epsilon?: number): boolean
Checks if the x,y,z components of this Vector3 are equal (within a small value of epsilon) to those of the given Vector3.
Parameters
- v: Vector3
  The Vector3 object to compare to
- epsilon: number = MathUtils.EPSILON
  A small value of acceptable variance to account for numerical instability
Returns boolean
A boolean value indicating if the Vector3 objects are equal
- Defined in math/Vector3.ts:442

inverse

inverse(): Vector3
Inverts a Vector3 object and returns the result as a new Vector3 object

Returns Vector3
- Defined in math/Vector3.ts:588

invert

invert(): void
Inverts a Vector3 object

Returns void
- Defined in math/Vector3.ts:577

length

length(): number
Calculates the length of a Vector3 object

Returns number
The length of the Vector3 object
- Defined in math/Vector3.ts:550

lerp

lerp(v1: Vector3, v2: Vector3, alpha: number): void
Linearly interpolates between two Vector3s
Parameters
- v1: Vector3
  The starting Vector3
- v2: Vector3
  The ending Vector3
- alpha: number
  The interpolation amount (should be in the range [0, 1])
Returns void
- Defined in math/Vector3.ts:705

multiply

multiply(v: Vector3): void
Multiplies this Vector3 by the given Vector3
Parameters
- v: Vector3
  The Vector3 object to multiply
Returns void
- Defined in math/Vector3.ts:476

multiplyScalar

multiplyScalar(n: number): void
Multiplies each component of the vector with a scalar value
Parameters
- n: number
  Scalar value to multiply with
Returns void
- Defined in math/Vector3.ts:526

normalize

normalize(): void
Normalizes a Vector3 object

Returns void
- Defined in math/Vector3.ts:559

reflect

reflect(normal: Vector3): void
Reflects this vector about a normal
Parameters
- normal: Vector3
Returns void
- Defined in math/Vector3.ts:717

rotate

rotate(q: Quaternion): void
Rotates this Vector3 instance by a given Quaternion
Parameters
- q: Quaternion
  The Quaternion to rotate this Vector3
Returns void
- Defined in math/Vector3.ts:627

set

set(x: number, y: number, z: number): void
Sets the x, y, and z values of a Vector3 object
Parameters
- x: number
  The x value to set
- y: number
  The y value to set
- z: number
  The z value to set
Returns void
- Defined in math/Vector3.ts:394

setPositionFromMatrix

setPositionFromMatrix(m: Matrix4): void
Sets this Vector3's position to the provided Matrix4's position
Parameters
- m: Matrix4
  The Matrix4 to get the position from
Returns void
- Defined in math/Vector3.ts:679

setScaleFromMatrix

setScaleFromMatrix(m: Matrix4): void
Sets this Vector3's scale to the provided Matrix4's scale
Parameters
- m: Matrix4
  The Matrix4 to get the scale from
Returns void
- Defined in math/Vector3.ts:691

subtract

subtract(v: Vector3): void
Subtracts the given Vector3 from this Vector3
Parameters
- v: Vector3
  The Vector3 object to subtract
Returns void
- Defined in math/Vector3.ts:464

transformPoint

transformPoint(m: Matrix4): void
Transforms this Vector3 instance as a point with a given Matrix4
Parameters
- m: Matrix4
  The Matrix4 to transform this Vector3
Returns void
- Defined in math/Vector3.ts:599

transformVector

transformVector(m: Matrix4): void
Transforms this Vector3 instance as a direction with a given Matrix4, ignoring the translation component
Parameters
- m: Matrix4
  The Matrix4 to transform this Vector3
Returns void
- Defined in math/Vector3.ts:613

`Static`add

add(v1: Vector3, v2: Vector3): Vector3
Adds two Vector3 objects together
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
Returns Vector3
A new Vector3 object with the x, y, and z values equal to the sum of the corresponding values of the input vectors
- Defined in math/Vector3.ts:112

`Static`angleBetween

angleBetween(v1: Vector3, v2: Vector3): number
Computes the angle in radians between two Vector3 objects
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
Returns number
The angle in radians between the two input vectors
- Defined in math/Vector3.ts:231

`Static`clone

clone(v: Vector3): Vector3
Creates a new Vector3 object that is a clone of the original
Parameters
- v: Vector3
  The Vector3 object to copy
Returns Vector3
A new Vector3 object with the same x, y, and z values as the original
- Defined in math/Vector3.ts:89

`Static`cross

cross(v1: Vector3, v2: Vector3): Vector3
Computes the cross product of two Vector3 objects
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
Returns Vector3
A new Vector3 object representing the cross product of the two input vectors
- Defined in math/Vector3.ts:172

`Static`distanceBetween

distanceBetween(v1: Vector3, v2: Vector3): number
Computes the distance between two Vector3 objects
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
Returns number
The distance between the two input vectors
- Defined in math/Vector3.ts:243

`Static`divide

divide(v1: Vector3, v2: Vector3): Vector3
Divide two Vector3 objects
Parameters
- v1: Vector3
  The Vector3 object to divide
- v2: Vector3
  The Vector3 object to divide by
Returns Vector3
A new Vector3 object with the x, y, and z values equal to the quotient of the corresponding values of the input vectors
- Defined in math/Vector3.ts:148

`Static`divideScalar

divideScalar(v: Vector3, n: number): Vector3
Divides a Vector3 object by a scalar value
Parameters
- v: Vector3
  The Vector3 object
- n: number
  The scalar value
Returns Vector3
A new Vector3 object with the x, y, and z values divided by the scalar value
- Defined in math/Vector3.ts:200

`Static`dot

dot(v1: Vector3, v2: Vector3): number
Computes the dot product of two Vector3 objects
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
Returns number
The dot product of the two input vectors
- Defined in math/Vector3.ts:160

`Static`equals

equals(v1: Vector3, v2: Vector3): boolean
Checks if the x,y,z components of two Vector3 objects are exactly equal.
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
Returns boolean
A boolean value indicating if the Vector3 objects are equal
- Defined in math/Vector3.ts:346

`Static`fuzzyEquals

fuzzyEquals(v1: Vector3, v2: Vector3, epsilon?: number): boolean
Checks if the x,y,z components of two Vector3 objects are equal within a small value of epsilon.
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
- epsilon: number = MathUtils.EPSILON
  A small value of acceptable variance to account for numerical instability
Returns boolean
A boolean value indicating if the Vector3 objects are equal
- Defined in math/Vector3.ts:359

`Static`inverse

inverse(v: Vector3): Vector3
Inverts the direction of a Vector3 object
Parameters
- v: Vector3
  The Vector3 object to invert
Returns Vector3
A new Vector3 object with the opposite direction of the original
- Defined in math/Vector3.ts:100

`Static`lerp

lerp(v1: Vector3, v2: Vector3, alpha: number): Vector3
Linearly interpolates between two Vector3 objects
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
- alpha: number
  The interpolation value between 0 and 1
Returns Vector3
A new Vector3 object that represents the result of interpolating between v1 and v2
- Defined in math/Vector3.ts:281

`Static`multiply

multiply(v1: Vector3, v2: Vector3): Vector3
Multiply two Vector3 objects
Parameters
- v1: Vector3
  The first Vector3 object
- v2: Vector3
  The second Vector3 object
Returns Vector3
A new Vector3 object with the x, y, and z values equal to the product of the corresponding values of the input vectors
- Defined in math/Vector3.ts:136

`Static`multiplyScalar

multiplyScalar(v: Vector3, n: number): Vector3
Multiplies a Vector3 object with a scalar value
Parameters
- v: Vector3
  The Vector3 object
- n: number
  The scalar value
Returns Vector3
A new Vector3 object with the x, y, and z values multiplied by the scalar value
- Defined in math/Vector3.ts:188

`Static`normalize

normalize(v: Vector3): Vector3
Normalizes a Vector3 object
Parameters
- v: Vector3
  The Vector3 object
Returns Vector3
A new Vector3 object with a magnitude of 1, pointing in the same direction as the original vector If the original vector is a zero vector, returns a new zero vector
- Defined in math/Vector3.ts:212

`Static`reflect

reflect(v: Vector3, n: Vector3): Vector3
Reflects a vector about a normal
Parameters
- v: Vector3
  The vector to reflect
- n: Vector3
  The normal to reflect about
Returns Vector3
A new Vector3 object that represents the result of reflecting v about n
- Defined in math/Vector3.ts:331

`Static`rotate

rotate(v: Vector3, q: Quaternion): Vector3
Rotates a Vector3 object by a Quaternion
Parameters
- v: Vector3
  The Vector3 object to rotate
- q: Quaternion
  The Quaternion object to rotate the Vector3 by
Returns Vector3
A new Vector3 object that represents the result of rotating v by q
- Defined in math/Vector3.ts:255

`Static`subtract

subtract(v1: Vector3, v2: Vector3): Vector3
Subtracts two Vector3 objects
Parameters
- v1: Vector3
  The Vector3 object to subtract from
- v2: Vector3
  The Vector3 object to subtract
Returns Vector3
A new Vector3 object with the x, y, and z values equal to the difference of the corresponding values of the input vectors
- Defined in math/Vector3.ts:124

`Static`transformPoint

transformPoint(v: Vector3, m: Matrix4): Vector3
Transforms a Vector3 object representing a point by a Matrix4
Parameters
- v: Vector3
  The Vector3 object to transform
- m: Matrix4
  The Matrix4 object to transform the Vector3 by
Returns Vector3
A new Vector3 object that represents the result of transforming point v by m
- Defined in math/Vector3.ts:297

`Static`transformVector

transformVector(v: Vector3, m: Matrix4): Vector3
Transforms a Vector3 object representing a direction by a Matrix4, ignoring the translation component
Parameters
- v: Vector3
  The Vector3 object to transform
- m: Matrix4
  The Matrix4 object to transform the Vector3 by
Returns Vector3
A new Vector3 object that represents the result of transforming direction v by m
- Defined in math/Vector3.ts:314

Class Vector3

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Vector3

Properties

x

y

z

Static ReadonlyBACK

Static ReadonlyDOWN

Static ReadonlyFORWARD

Static ReadonlyLEFT

Static ReadonlyONE

Static ReadonlyRIGHT

Static ReadonlyUP

Static ReadonlyX_AXIS

Static ReadonlyY_AXIS

Static ReadonlyZ_AXIS

Static ReadonlyZERO

Methods

add

Parameters

Returns void

angleBetween

Parameters

Returns number

clone

Returns Vector3

copy

Parameters

Returns void

cross

Parameters

Returns void

distanceTo

Parameters

Returns number

divide

Parameters

Returns void

divideScalar

Parameters

Returns void

dot

Parameters

Returns number

equals

Parameters

Returns boolean

fuzzyEquals

Parameters

Returns boolean

inverse

Returns Vector3

invert

Returns void

length

Returns number

lerp

Parameters

Returns void

multiply

Parameters

Returns void

multiplyScalar

Parameters

Returns void

normalize

Returns void

reflect

Parameters

Returns void

rotate

Parameters

Returns void

`Static` `Readonly`BACK

`Static` `Readonly`DOWN

`Static` `Readonly`FORWARD

`Static` `Readonly`LEFT

`Static` `Readonly`ONE

`Static` `Readonly`RIGHT

`Static` `Readonly`UP

`Static` `Readonly`X_AXIS

`Static` `Readonly`Y_AXIS

`Static` `Readonly`Z_AXIS

`Static` `Readonly`ZERO

`Static`add

`Static`angleBetween

`Static`clone

`Static`cross

`Static`distanceBetween

`Static`divide

`Static`divideScalar

`Static`dot

`Static`equals

`Static`fuzzyEquals

`Static`inverse

`Static`lerp

`Static`multiply

`Static`multiplyScalar

`Static`normalize

`Static`reflect

`Static`rotate

`Static`subtract