Phaser.Math.Vector3 - Phaser 3 API Documentation

name	type	arguments	description
x	number	<optional>	The x component.
y	number	<optional>	The y component.
z	number	<optional>	The z component.

<static, constant> BACK: Phaser.Math.Vector3

Description:

A static back Vector3 for use by reference.

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

Type:

Phaser.Math.Vector3

Since: 3.16.0

Source: src/math/Vector3.js (Line 1036)

<static, constant> DOWN: Phaser.Math.Vector3

Description:

A static down Vector3 for use by reference.

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

Type:

Phaser.Math.Vector3

Since: 3.16.0

Source: src/math/Vector3.js (Line 1012)

<static, constant> FORWARD: Phaser.Math.Vector3

Description:

A static forward Vector3 for use by reference.

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

Type:

Phaser.Math.Vector3

Since: 3.16.0

Source: src/math/Vector3.js (Line 1024)

<static, constant> LEFT: Phaser.Math.Vector3

Description:

A static left Vector3 for use by reference.

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

Type:

Phaser.Math.Vector3

Since: 3.16.0

Source: src/math/Vector3.js (Line 988)

<static, constant> ONE: Phaser.Math.Vector3

Description:

A static one Vector3 for use by reference.

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

Type:

Phaser.Math.Vector3

Since: 3.16.0

Source: src/math/Vector3.js (Line 1048)

<static, constant> RIGHT: Phaser.Math.Vector3

Description:

A static right Vector3 for use by reference.

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

Type:

Phaser.Math.Vector3

Since: 3.16.0

Source: src/math/Vector3.js (Line 976)

<static, constant> UP: Phaser.Math.Vector3

Description:

A static up Vector3 for use by reference.

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

Type:

Phaser.Math.Vector3

Since: 3.16.0

Source: src/math/Vector3.js (Line 1000)

<static, constant> ZERO: Phaser.Math.Vector3

Description:

A static zero Vector3 for use by reference.

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

Type:

Phaser.Math.Vector3

Since: 3.16.0

Source: src/math/Vector3.js (Line 964)

x: number

Description:

The x component of this Vector.

Type:

number

Default: 0

Since: 3.0.0

Source: src/math/Vector3.js (Line 33)

y: number

Description:

The y component of this Vector.

Type:

number

Default: 0

Since: 3.0.0

Source: src/math/Vector3.js (Line 43)

z: number

Description:

The z component of this Vector.

Type:

number

Default: 0

Since: 3.0.0

Source: src/math/Vector3.js (Line 53)

add(v)

Description:

Add a given Vector to this Vector. Addition is component-wise.

Parameters:

name	type	description
v	Phaser.Math.Vector2 \| Phaser.Math.Vector3	The Vector to add to this Vector.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 337)

addScalar(s)

Description:

Add the given value to each component of this Vector.

Parameters:

name	type	description
s	number	The amount to add to this Vector.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 356)

addScale(v, scale)

Description:

Add and scale a given Vector to this Vector. Addition is component-wise.

Parameters:

name	type	description
v	Phaser.Math.Vector2 \| Phaser.Math.Vector3	The Vector to add to this Vector.
scale	number	The amount to scale `v` by.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 375)

addVectors(a, b)

Description:

Adds the two given Vector3s and sets the results into this Vector3.

Parameters:

name	type	description
a	Phaser.Math.Vector3	The first Vector to add.
b	Phaser.Math.Vector3	The second Vector to add.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 147)

applyMatrix3(mat3)

Description:

Takes a Matrix3 and applies it to this Vector3.

Parameters:

name	type	description
mat3	Phaser.Math.Matrix3	The Matrix3 to apply to this Vector3.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 671)

applyMatrix4(mat4)

Description:

Takes a Matrix4 and applies it to this Vector3.

Parameters:

name	type	description
mat4	Phaser.Math.Matrix4	The Matrix4 to apply to this Vector3.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 695)

clone()

Description:

Make a clone of this Vector3.

Returns:

Description:

A new Vector3 object containing this Vectors values.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 134)

copy(src)

Description:

Copy the components of a given Vector into this Vector.

Parameters:

name	type	description
src	Phaser.Math.Vector2 \| Phaser.Math.Vector3	The Vector to copy the components from.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 231)

cross(v)

Description:

Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.

Parameters:

name	type	description
v	Phaser.Math.Vector3	The Vector to cross product with.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 617)

crossVectors(a, b)

Description:

Calculate the cross (vector) product of two given Vectors.

Parameters:

name	type	description
a	Phaser.Math.Vector3	The first Vector to multiply.
b	Phaser.Math.Vector3	The second Vector to multiply.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 187)

distance(v)

Description:

Calculate the distance between this Vector and the given Vector.

Parameters:

name	type	description
v	Phaser.Math.Vector2 \| Phaser.Math.Vector3	The Vector to calculate the distance to.

Returns:

Description:

The distance from this Vector to the given Vector.

Type:

number

Since: 3.0.0

Source: src/math/Vector3.js (Line 501)

distanceSq(v)

Description:

Calculate the distance between this Vector and the given Vector, squared.

Parameters:

name	type	description
v	Phaser.Math.Vector2 \| Phaser.Math.Vector3	The Vector to calculate the distance to.

Returns:

Description:

The distance from this Vector to the given Vector, squared.

Type:

number

Since: 3.0.0

Source: src/math/Vector3.js (Line 520)

divide(v)

Description:

Perform a component-wise division between this Vector and the given Vector.

Divides this Vector by the given Vector.

Parameters:

name	type	description
v	Phaser.Math.Vector2 \| Phaser.Math.Vector3	The Vector to divide this Vector by.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 463)

dot(v)

Description:

Calculate the dot product of this Vector and the given Vector.

Parameters:

name	type	description
v	Phaser.Math.Vector3	The Vector3 to dot product with this Vector3.

Returns:

Description:

The dot product of this Vector and v.

Type:

number

Since: 3.0.0

Source: src/math/Vector3.js (Line 602)

equals(v)

Description:

Check whether this Vector is equal to a given Vector.

Performs a strict equality check against each Vector's components.

Parameters:

name	type	description
v	Phaser.Math.Vector3	The Vector3 to compare against.

Returns:

Description:

True if the two vectors strictly match, otherwise false.

Type:

boolean

Since: 3.0.0

Source: src/math/Vector3.js (Line 214)

fromArray(array, [offset])

Description:

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:

name	type	arguments	description
array	Array.<number>		The array of values to get this Vector from.
offset	number	<optional>	The offset index into the array.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 311)

length()

Description:

Calculate the length (or magnitude) of this Vector.

Returns:

Description:

The length of this Vector.

Type:

number

Since: 3.0.0

Source: src/math/Vector3.js (Line 539)

lengthSq()

Description:

Calculate the length of this Vector squared.

Returns:

Description:

The length of this Vector, squared.

Type:

number

Since: 3.0.0

Source: src/math/Vector3.js (Line 556)

lerp(v, [t])

Description:

Linearly interpolate between this Vector and the given Vector.

Interpolates this Vector towards the given Vector.

Parameters:

name	type	arguments	description
v	Phaser.Math.Vector3		The Vector3 to interpolate towards.
t	number	<optional>	The interpolation percentage, between 0 and 1.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 643)

max(v)

Description:

Sets the components of this Vector to be the Math.max result from the given vector.

Parameters:

name	type	description
v	Phaser.Math.Vector3	The Vector3 to check the maximum values against.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 115)

min(v)

Description:

Sets the components of this Vector to be the Math.min result from the given vector.

Parameters:

name	type	description
v	Phaser.Math.Vector3	The Vector3 to check the minimum values against.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 96)

multiply(v)

Description:

Perform a component-wise multiplication between this Vector and the given Vector.

Multiplies this Vector by the given Vector.

Parameters:

name	type	description
v	Phaser.Math.Vector2 \| Phaser.Math.Vector3	The Vector to multiply this Vector by.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 414)

negate()

Description:

Negate the x, y and z components of this Vector.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 484)

normalize()

Description:

Normalize this Vector.

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

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 573)

project(mat)

Description:

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:

name	type	description
mat	Phaser.Math.Matrix4	The Matrix4 to multiply this Vector3 with.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 833)

projectViewMatrix(viewMatrix, projectionMatrix)

Description:

Multiplies this Vector3 by the given view and projection matrices.

Parameters:

name	type	description
viewMatrix	Phaser.Math.Matrix4	A View Matrix.
projectionMatrix	Phaser.Math.Matrix4	A Projection Matrix.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 877)

reset()

Description:

Make this Vector the zero vector (0, 0, 0).

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 945)

scale(scale)

Description:

Scale this Vector by the given value.

Parameters:

name	type	description
scale	number	The value to scale this Vector by.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 435)

set(x, [y], [z])

Description:

Set the x, y, and z components of this Vector to the given x, y, and z values.

Parameters:

name	type	arguments	description
x	number \| object		The x value to set for this Vector, or an object containing x, y and z components.
y	number	<optional>	The y value to set for this Vector.
z	number	<optional>	The z value to set for this Vector.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 250)

setFromMatrixColumn(mat4, index)

Description:

Sets the components of this Vector3 from the Matrix4 column specified.

Parameters:

name	type	description
mat4	Phaser.Math.Matrix4	The Matrix4 to get the column from.
index	number	The column index.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 295)

setFromMatrixPosition(mat4)

Description:

Sets the components of this Vector3 from the position of the given Matrix4.

Parameters:

name	type	description
mat4	Phaser.Math.Matrix4	The Matrix4 to get the position from.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 280)

subVectors(a, b)

Description:

Subtracts the two given Vector3s and sets the results into this Vector3.

Parameters:

name	type	description
a	Phaser.Math.Vector3	The first Vector to sub.
b	Phaser.Math.Vector3	The second Vector to sub.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.85.0

Source: src/math/Vector3.js (Line 167)

subtract(v)

Description:

Subtract the given Vector from this Vector. Subtraction is component-wise.

Parameters:

name	type	description
v	Phaser.Math.Vector2 \| Phaser.Math.Vector3	The Vector to subtract from this Vector.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 395)

transformCoordinates(mat)

Description:

Transforms the coordinates of this Vector3 with the given Matrix4.

Parameters:

name	type	description
mat	Phaser.Math.Matrix4	The Matrix4 to transform this Vector3 with.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 769)

transformMat3(mat)

Description:

Transform this Vector with the given Matrix.

Parameters:

name	type	description
mat	Phaser.Math.Matrix3	The Matrix3 to transform this Vector3 with.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 721)

transformMat4(mat)

Description:

Transform this Vector with the given Matrix4.

Parameters:

name	type	description
mat	Phaser.Math.Matrix4	The Matrix4 to transform this Vector3 with.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 745)

transformQuat(q)

Description:

Transform this Vector with the given Quaternion.

Parameters:

name	type	description
q	Phaser.Math.Quaternion	The Quaternion to transform this Vector with.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 798)

unproject(viewport, invProjectionView)

Description:

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:

name	type	description
viewport	Phaser.Math.Vector4	Screen x, y, width and height in pixels.
invProjectionView	Phaser.Math.Matrix4	Combined projection and view matrix.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 909)

unprojectViewMatrix(projectionMatrix, worldMatrix)

Description:

Multiplies this Vector3 by the given inversed projection matrix and world matrix.

Parameters:

name	type	description
projectionMatrix	Phaser.Math.Matrix4	An inversed Projection Matrix.
worldMatrix	Phaser.Math.Matrix4	A World View Matrix.

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.50.0

Source: src/math/Vector3.js (Line 893)

up()

Description:

Set this Vector to point up.

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

Returns:

Description:

This Vector3.

Type:

Phaser.Math.Vector3

Since: 3.0.0

Source: src/math/Vector3.js (Line 77)

Filter

Phaser . Math . Vector3

Phaser . Math . Vector3

Constructor:

Parameters:

Members

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Methods

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters: