Filter

Hide inherited members:

show private members:

Phaser . Math . Quaternion

A quaternion.

Constructor:

new Quaternion([x], [y], [z], [w])

Parameters:

name	type	arguments	Default	description
x	number	<optional>	0	The x component.
y	number	<optional>	0	The y component.
z	number	<optional>	0	The z component.
w	number	<optional>	1	The w component.

Since: 3.0.0

Source: src/math/Quaternion.js (Line 27)

Members

<private> _w: number

Description:

The w component of this Quaternion.

Type:

number

Default: 0

Since: 3.50.0

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

<private> _x: number

Description:

The x component of this Quaternion.

Type:

number

Default: 0

Since: 3.50.0

Source: src/math/Quaternion.js (Line 47)

<private> _y: number

Description:

The y component of this Quaternion.

Type:

number

Default: 0

Since: 3.50.0

Source: src/math/Quaternion.js (Line 57)

<private> _z: number

Description:

The z component of this Quaternion.

Type:

number

Default: 0

Since: 3.50.0

Source: src/math/Quaternion.js (Line 67)

onChangeCallback: function

Description:

This callback is invoked, if set, each time a value in this quaternion is changed. The callback is passed one argument, a reference to this quaternion.

Type:

function

Since: 3.50.0

Source: src/math/Quaternion.js (Line 87)

w: number

Description:

The w component of this Quaternion.

Type:

number

Default: 0

Since: 3.0.0

Source: src/math/Quaternion.js (Line 166)

x: number

Description:

The x component of this Quaternion.

Type:

number

Default: 0

Since: 3.0.0

Source: src/math/Quaternion.js (Line 100)

y: number

Description:

The y component of this Quaternion.

Type:

number

Default: 0

Since: 3.0.0

Source: src/math/Quaternion.js (Line 122)

z: number

Description:

The z component of this Quaternion.

Type:

number

Default: 0

Since: 3.0.0

Source: src/math/Quaternion.js (Line 144)

Methods

add(v)

Description:

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

Parameters:

name	type	description
v	Phaser.Math.Quaternion \| Phaser.Math.Vector4	The Quaternion or Vector to add to this Quaternion.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 244)

calculateW()

Description:

Create a unit (or rotation) Quaternion from its x, y, and z components.

Sets the w component.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 763)

conjugate()

Description:

Convert this Quaternion into its conjugate.

Sets the x, y and z components.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 652)

copy(src)

Description:

Copy the components of a given Quaternion or Vector into this Quaternion.

Parameters:

name	type	description
src	Phaser.Math.Quaternion \| Phaser.Math.Vector4	The Quaternion or Vector to copy the components from.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 188)

dot(v)

Description:

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

Parameters:

name	type	description
v	Phaser.Math.Quaternion \| Phaser.Math.Vector4	The Quaternion or Vector to dot product with this Quaternion.

Returns:

Description:

The dot product of this Quaternion and the given Quaternion or Vector.

Type:

number

Since: 3.0.0

Source: src/math/Quaternion.js (Line 377)

fromMat3(mat)

Description:

Convert the given Matrix into this Quaternion.

Parameters:

name	type	description
mat	Phaser.Math.Matrix3	The Matrix to convert from.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 968)

identity()

Description:

Reset this Matrix to an identity (default) Quaternion.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 495)

invert()

Description:

Invert this Quaternion.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 626)

length()

Description:

Calculate the length of this Quaternion.

Returns:

Description:

The length of this Quaternion.

Type:

number

Since: 3.0.0

Source: src/math/Quaternion.js (Line 310)

lengthSq()

Description:

Calculate the length of this Quaternion squared.

Returns:

Description:

The length of this Quaternion, squared.

Type:

number

Since: 3.0.0

Source: src/math/Quaternion.js (Line 328)

lerp(v, [t])

Description:

Linearly interpolate this Quaternion towards the given Quaternion or Vector.

Parameters:

name	type	arguments	description
v	Phaser.Math.Quaternion \| Phaser.Math.Vector4		The Quaternion or Vector to interpolate towards.
t	number	<optional>	The percentage of interpolation.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 392)

multiply(b)

Description:

Multiply this Quaternion by the given Quaternion or Vector.

Parameters:

name	type	description
b	Phaser.Math.Quaternion \| Phaser.Math.Vector4	The Quaternion or Vector to multiply this Quaternion by.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 533)

normalize()

Description:

Normalize this Quaternion.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 346)

rotateX(rad)

Description:

Rotate this Quaternion on the X axis.

Parameters:

name	type	description
rad	number	The rotation angle in radians.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 673)

rotateY(rad)

Description:

Rotate this Quaternion on the Y axis.

Parameters:

name	type	description
rad	number	The rotation angle in radians.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 703)

rotateZ(rad)

Description:

Rotate this Quaternion on the Z axis.

Parameters:

name	type	description
rad	number	The rotation angle in radians.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 733)

rotationTo(a, b)

Description:

Rotates this Quaternion based on the two given vectors.

Parameters:

name	type	description
a	Phaser.Math.Vector3	The transform rotation vector.
b	Phaser.Math.Vector3	The target rotation vector.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 420)

scale(scale)

Description:

Scale this Quaternion by the given value.

Parameters:

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

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 288)

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

Description:

Set the components of this Quaternion and optionally call the onChangeCallback.

Parameters:

name	type	arguments	Default	description
x	number \| object	<optional>	0	The x component, or an object containing x, y, z, and w components.
y	number	<optional>	0	The y component.
z	number	<optional>	0	The z component.
w	number	<optional>	0	The w component.
update	boolean	<optional>	true	Call the `onChangeCallback`?

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 203)

setAxes(view, right, up)

Description:

Set the axes of this Quaternion.

Parameters:

name	type	description
view	Phaser.Math.Vector3	The view axis.
right	Phaser.Math.Vector3	The right axis.
up	Phaser.Math.Vector3	The upwards axis.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 464)

setAxisAngle(axis, rad)

Description:

Set the axis angle of this Quaternion.

Parameters:

name	type	description
axis	Phaser.Math.Vector3	The axis.
rad	number	The angle in radians.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 508)

setFromEuler(euler, [update])

Description:

Set this Quaternion from the given Euler, based on Euler order.

Parameters:

name	type	arguments	Default	description
euler	Phaser.Math.Euler			The Euler to convert from.
update	boolean	<optional>	true	Run the `onChangeCallback`?

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.50.0

Source: src/math/Quaternion.js (Line 784)

setFromRotationMatrix(mat4)

Description:

Sets the rotation of this Quaternion from the given Matrix4.

Parameters:

name	type	description
mat4	Phaser.Math.Matrix4	The Matrix4 to set the rotation from.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.50.0

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

slerp(b, t)

Description:

Smoothly linearly interpolate this Quaternion towards the given Quaternion or Vector.

Parameters:

name	type	description
b	Phaser.Math.Quaternion \| Phaser.Math.Vector4	The Quaternion or Vector to interpolate towards.
t	number	The percentage of interpolation.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 563)

subtract(v)

Description:

Subtract a given Quaternion or Vector from this Quaternion. Subtraction is component-wise.

Parameters:

name	type	description
v	Phaser.Math.Quaternion \| Phaser.Math.Vector4	The Quaternion or Vector to subtract from this Quaternion.

Returns:

Description:

This Quaternion.

Type:

Phaser.Math.Quaternion

Since: 3.0.0

Source: src/math/Quaternion.js (Line 266)

Possible examples