Class Vector3

A Vector3 is a mathematical object representing a point or direction in 3D space, defined by three components: x, y, and z.

Vector3 objects are used throughout Phaser's 3D math utilities, including matrix transformations, quaternion rotations, camera unprojection, and 3D-to-2D projection. They are commonly used when working with 3D renderers, custom shaders, or any code that needs to represent positions, directions, or normals in three-dimensional space.

The class includes methods for common vector operations such as addition, subtraction, scaling, normalization, dot and cross products, linear interpolation, and transformation by Matrix3, Matrix4, and Quaternion objects.

A set of static read-only constants (e.g. Vector3.UP, Vector3.FORWARD) are provided for convenient directional references.

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
Parameters
- Optionalx: number
  The x component.
- Optionaly: number
  The y component.
- Optionalz: number
  The z component.
Returns Vector3
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94232

Properties

x

x: number

The x component of this Vector.

y

y: number

The y component of this Vector.

z

z: number

The z component of this Vector.

`Static` `Readonly`BACK

A static back Vector3 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`DOWN

A static down Vector3 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`FORWARD

FORWARD: Vector3

A static forward Vector3 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`LEFT

A static left Vector3 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`ONE

A static one Vector3 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`RIGHT

RIGHT: Vector3

A static right Vector3 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`UP

A static up Vector3 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`ZERO

A static zero Vector3 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

Methods

add

add(v: Vector2 | Vector3): Vector3
Add a given Vector to this Vector. Addition is component-wise.
Parameters
- v: Vector2 | Vector3
  The Vector to add to this Vector.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94358

addScalar

addScalar(s: number): Vector3
Add the given value to each component of this Vector.
Parameters
- s: number
  The amount to add to this Vector.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94365

addScale

addScale(v: Vector2 | Vector3, scale: number): Vector3
Add and scale a given Vector to this Vector. Addition is component-wise.
Parameters
- v: Vector2 | Vector3
  The Vector to add to this Vector.
- scale: number
  The amount to scale v by.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94373

addVectors

addVectors(a: Vector3, b: Vector3): Vector3
Adds the two given Vector3s and sets the results into this Vector3.
Parameters
- a: Vector3
  The first Vector to add.
- b: Vector3
  The second Vector to add.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94283

applyMatrix3

applyMatrix3(mat3: Matrix3): Vector3
Takes a Matrix3 and applies it to this Vector3.
Parameters
- mat3: Matrix3
  The Matrix3 to apply to this Vector3.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94476

applyMatrix4

applyMatrix4(mat4: Matrix4): Vector3
Takes a Matrix4 and applies it to this Vector3.
Parameters
- mat4: Matrix4
  The Matrix4 to apply to this Vector3.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94483

clone

clone(): Vector3
Make a clone of this Vector3.undefined

Returns Vector3
A new Vector3 object containing this Vector's values.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94275

copy

copy(src: Vector2 | Vector3): Vector3
Copy the components of a given Vector into this Vector.
Parameters
- src: Vector2 | Vector3
  The Vector to copy the components from.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94315

cross

cross(v: Vector3): Vector3
Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.
Parameters
- v: Vector3
  The Vector to cross product with.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94459

crossVectors

crossVectors(a: Vector3, b: Vector3): Vector3
Calculate the cross (vector) product of two given Vectors.
Parameters
- a: Vector3
  The first Vector to use in the cross product calculation.
- b: Vector3
  The second Vector to use in the cross product calculation.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94299

distance

distance(v: Vector2 | Vector3): number
Calculate the distance between this Vector and the given Vector.
Parameters
- v: Vector2 | Vector3
  The Vector to calculate the distance to.
Returns number
The distance from this Vector to the given Vector.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94418

distanceSq

distanceSq(v: Vector2 | Vector3): number
Calculate the distance between this Vector and the given Vector, squared.
Parameters
- v: Vector2 | Vector3
  The Vector to calculate the distance to.
Returns number
The distance from this Vector to the given Vector, squared.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94425

divide

divide(v: Vector2 | Vector3): Vector3
Perform a component-wise division between this Vector and the given Vector.

Divides this Vector by the given Vector.
Parameters
- v: Vector2 | Vector3
  The Vector to divide this Vector by.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94405

dot

dot(v: Vector3): number
Calculate the dot product of this Vector and the given Vector.
Parameters
- v: Vector3
  The Vector3 to dot product with this Vector3.
Returns number
The dot product of this Vector and v.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94452

equals

equals(v: Vector3): boolean
Check whether this Vector is equal to a given Vector.

Performs a strict equality check against each Vector's components.
Parameters
- v: Vector3
  The Vector3 to compare against.
Returns boolean
True if the two vectors strictly match, otherwise false.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94308

fromArray

fromArray(array: number[], offset?: number): Vector3
Sets the components of this Vector3 from the given array, based on the offset.

Vector3.x = array[offset] Vector3.y = array[offset + 1] Vector3.z = array[offset + 2]
Parameters
- array: number[]
  The array of values to get this Vector from.
- Optionaloffset: number
  The offset index into the array. Default 0.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94351

length

length(): number
Calculate the length (or magnitude) of this Vector.undefined

Returns number
The length of this Vector.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94431

lengthSq

lengthSq(): number
Calculate the length of this Vector squared.undefined

Returns number
The length of this Vector, squared.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94437

lerp

lerp(v: Vector3, t?: number): Vector3
Linearly interpolate between this Vector and the given Vector.

Interpolates this Vector towards the given Vector.
Parameters
- v: Vector3
  The Vector3 to interpolate towards.
- Optionalt: number
  The interpolation factor, between 0 and 1. Default 0.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94469

max

max(v: Vector3): Vector3
Sets the components of this Vector to be the Math.max result from the given vector.
Parameters
- v: Vector3
  The Vector3 to check the maximum values against.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94269

min

min(v: Vector3): Vector3
Sets the components of this Vector to be the Math.min result from the given vector.
Parameters
- v: Vector3
  The Vector3 to check the minimum values against.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94262

multiply

multiply(v: Vector2 | Vector3): Vector3
Perform a component-wise multiplication between this Vector and the given Vector.

Multiplies this Vector by the given Vector.
Parameters
- v: Vector2 | Vector3
  The Vector to multiply this Vector by.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94389

negate

negate(): Vector3
Negate the x, y and z components of this Vector.undefined

Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94411

normalize

normalize(): Vector3
Normalize this Vector.

Makes the vector a unit length vector (magnitude of 1) in the same direction.undefined

Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94445

project

project(mat: Matrix4): Vector3
Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection, e.g. unprojecting a 2D point into 3D space.
Parameters
- mat: Matrix4
  The Matrix4 to multiply this Vector3 with.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94519

projectViewMatrix

projectViewMatrix(viewMatrix: Matrix4, projectionMatrix: Matrix4): Vector3
Multiplies this Vector3 by the given view and projection matrices.
Parameters
- viewMatrix: Matrix4
  A View Matrix.
- projectionMatrix: Matrix4
  A Projection Matrix.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94527

reset

reset(): Vector3
Make this Vector the zero vector (0, 0, 0).undefined

Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94556

scale

scale(scale: number): Vector3
Scale this Vector by the given value.
Parameters
- scale: number
  The value to scale this Vector by.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94396

set

set(x: number | object, y?: number, z?: number): Vector3
Set the x, y, and z components of this Vector to the given x, y, and z values.
Parameters
- x: number | object
  The x value to set for this Vector, or an object containing x, y and z components.
- Optionaly: number
  The y value to set for this Vector.
- Optionalz: number
  The z value to set for this Vector.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94324

setFromMatrixColumn

setFromMatrixColumn(mat4: Matrix4, index: number): Vector3
Sets the components of this Vector3 from the Matrix4 column specified.
Parameters
- mat4: Matrix4
  The Matrix4 to get the column from.
- index: number
  The column index.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94339

setFromMatrixPosition

setFromMatrixPosition(mat4: Matrix4): Vector3
Sets the components of this Vector3 from the position of the given Matrix4.
Parameters
- mat4: Matrix4
  The Matrix4 to get the position from.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94331

subtract

subtract(v: Vector2 | Vector3): Vector3
Subtract the given Vector from this Vector. Subtraction is component-wise.
Parameters
- v: Vector2 | Vector3
  The Vector to subtract from this Vector.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94380

subVectors

subVectors(a: Vector3, b: Vector3): Vector3
Subtracts the two given Vector3s and sets the results into this Vector3.
Parameters
- a: Vector3
  The Vector to subtract from.
- b: Vector3
  The Vector to subtract.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94291

transformCoordinates

transformCoordinates(mat: Matrix4): Vector3
Transforms the coordinates of this Vector3 with the given Matrix4.
Parameters
- mat: Matrix4
  The Matrix4 to transform this Vector3 with.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94504

transformMat3

transformMat3(mat: Matrix3): Vector3
Transform this Vector with the given Matrix.
Parameters
- mat: Matrix3
  The Matrix3 to transform this Vector3 with.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94490

transformMat4

transformMat4(mat: Matrix4): Vector3
Transform this Vector with the given Matrix4.
Parameters
- mat: Matrix4
  The Matrix4 to transform this Vector3 with.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94497

transformQuat

transformQuat(q: Quaternion): Vector3
Transform this Vector with the given Quaternion.
Parameters
- q: Quaternion
  The Quaternion to transform this Vector with.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94511

unproject

unproject(viewport: Vector4, invProjectionView: Matrix4): Vector3
Unproject this point from 2D space to 3D space. The point should have its x and y properties set to 2D screen space, and the z either at 0 (near plane) or 1 (far plane). The provided matrix is assumed to already be combined, i.e. projection * view * model.

After this operation, this vector's (x, y, z) components will represent the unprojected 3D coordinate.
Parameters
- viewport: Vector4
  Screen x, y, width and height in pixels.
- invProjectionView: Matrix4
  Combined projection and view matrix.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94550

unprojectViewMatrix

unprojectViewMatrix(projectionMatrix: Matrix4, worldMatrix: Matrix4): Vector3
Multiplies this Vector3 by the given inversed projection matrix and world matrix.
Parameters
- projectionMatrix: Matrix4
  An inversed Projection Matrix.
- worldMatrix: Matrix4
  A World View Matrix.
Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94535

up

up(): Vector3
Set this Vector to point up.

Sets the y component of the vector to 1, and the others to 0.undefined

Returns Vector3
This Vector3.
- Defined in node_modules/.pnpm/phaser@4.2.1/node_modules/phaser/types/phaser.d.ts:94255