Class Quaternion

Represents a four dimensional mathematical quaternion.

Hierarchy

Quaternion

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion
Constructor of Quaternion.
Parameters
- x: number = 0
  
  The x component of the quaternion, default 0
- y: number = 0
  
  The y component of the quaternion, default 0
- z: number = 0
  
  The z component of the quaternion, default 0
- w: number = 1
  
  The w component of the quaternion, default 1
Returns Quaternion
- Defined in math/Quaternion.ts:509

Properties

_onValueChanged

_onValueChanged: (() => void) = null

Type declaration

- (): void
- Internal
  Returns void

`Internal` _w

_w: number

`Internal` _x

_x: number

`Internal` _y

_y: number

`Internal` _z

_z: number

`Static` `Readonly` `Internal` _tempQuat1

_tempQuat1: Quaternion = ...

`Static` `Readonly` `Internal` _tempVector3

_tempVector3: Vector3 = ...

Accessors

normalized

get normalized(): boolean
Indicting whether this instance is normalized.

Returns boolean
- Defined in math/Quaternion.ts:483

w

get w(): number
The w component of the quaternion.

Returns number
- Defined in math/Quaternion.ts:493
set w(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Quaternion.ts:497

x

get x(): number
The x component of the quaternion.

Returns number
- Defined in math/Quaternion.ts:447
set x(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Quaternion.ts:451

y

get y(): number
The y component of the quaternion.

Returns number
- Defined in math/Quaternion.ts:459
set y(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Quaternion.ts:463

z

get z(): number
The z component of the quaternion.

Returns number
- Defined in math/Quaternion.ts:471
set z(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Quaternion.ts:475

Methods

`Private` _toYawPitchRoll

_toYawPitchRoll(out: Vector3): Vector3
Parameters
- out: Vector3
Returns Vector3
- Defined in math/Quaternion.ts:777

clone

clone(): Quaternion
Creates a clone of this quaternion.

Returns
A clone of this quaternion

Returns Quaternion
- Defined in math/Quaternion.ts:667

cloneTo

cloneTo(out: Quaternion): Quaternion
Clones this quaternion to the specified quaternion.

Returns
The specified quaternion
Parameters
- out: Quaternion
  
  The specified quaternion
Returns Quaternion
- Defined in math/Quaternion.ts:676

conjugate

conjugate(): Quaternion
Transforms this quaternion into its conjugated version.

Returns
This quaternion

Returns Quaternion
- Defined in math/Quaternion.ts:552

dot

dot(quat: Quaternion): number
Determines the dot product of this quaternion and the specified quaternion.

Returns
The dot product of two quaternions
Parameters
- quat: Quaternion
  
  The specified quaternion
Returns number
- Defined in math/Quaternion.ts:750

getAxisAngle

getAxisAngle(out: Vector3): number
Get the rotation axis and rotation angle of the quaternion (unit: radians).

Returns
The rotation angle (unit: radians)
Parameters
- out: Vector3
  
  The axis as an output parameter
Returns number
- Defined in math/Quaternion.ts:565

identity

identity(): Quaternion
Identity this quaternion.

Returns
This quaternion after identity

Returns Quaternion
- Defined in math/Quaternion.ts:589

invert

invert(): Quaternion
Invert this quaternion.

Returns
This quaternion after invert

Returns Quaternion
- Defined in math/Quaternion.ts:740

length

length(): number
Calculate the length of this quaternion.

Returns
The length of this quaternion

Returns number
- Defined in math/Quaternion.ts:602

lengthSquared

lengthSquared(): number
Calculates the squared length of this quaternion.

Returns
The squared length of this quaternion

Returns number
- Defined in math/Quaternion.ts:611

lerp

lerp(quat: Quaternion, t: number): Quaternion
Performs a linear blend between this quaternion and the specified quaternion.

Returns
- The result of linear blending between two quaternions
Parameters
- quat: Quaternion
  
  The specified quaternion
- t: number
  
  The blend amount where 0 returns this and 1 quat
Returns Quaternion
- Defined in math/Quaternion.ts:760

multiply

multiply(quat: Quaternion): Quaternion
Determines the product of this quaternion and the specified quaternion.

Returns
The product of the two quaternions
Parameters
- quat: Quaternion
  
  The specified quaternion
Returns Quaternion
- Defined in math/Quaternion.ts:731

normalize

normalize(): Quaternion
Converts this quaternion into a unit quaternion.

Returns
This quaternion

Returns Quaternion
- Defined in math/Quaternion.ts:620

rotateAxisAngle

rotateAxisAngle(axis: Vector3, rad: number): Quaternion
Calculate this quaternion rotation around an arbitrary axis.

Returns
This quaternion
Parameters
- axis: Vector3
  
  The axis
- rad: number
  
  The rotation angle in radians
Returns Quaternion
- Defined in math/Quaternion.ts:771

rotateX

rotateX(rad: number): Quaternion
Calculate this quaternion rotate around X axis.

Returns
This quaternion
Parameters
- rad: number
  
  The rotation angle in radians
Returns Quaternion
- Defined in math/Quaternion.ts:690

rotateY

rotateY(rad: number): Quaternion
Calculate this quaternion rotate around Y axis.

Returns
This quaternion
Parameters
- rad: number
  
  The rotation angle in radians
Returns Quaternion
- Defined in math/Quaternion.ts:700

rotateZ

rotateZ(rad: number): Quaternion
Calculate this quaternion rotate around Z axis.

Returns
This quaternion
Parameters
- rad: number
  
  The rotation angle in radians
Returns Quaternion
- Defined in math/Quaternion.ts:710

rotationAxisAngle

rotationAxisAngle(axis: Vector3, rad: number): Quaternion
Calculate this quaternion rotates around an arbitrary axis.

Returns
This quaternion
Parameters
- axis: Vector3
  
  The axis
- rad: number
  
  The rotation angle in radians
Returns Quaternion
- Defined in math/Quaternion.ts:721

setValue

setValue(x: number, y: number, z: number, w: number): Quaternion
Set the value of this quaternion, and return this quaternion.

Returns
This quaternion
Parameters
- x: number
  
  The x component of the quaternion
- y: number
  
  The y component of the quaternion
- z: number
  
  The z component of the quaternion
- w: number
  
  The w component of the quaternion
Returns Quaternion
- Defined in math/Quaternion.ts:524

setValueByArray

setValueByArray(array: ArrayLike<number>, offset?: number): Quaternion
Set the value of this quaternion by an array.

Returns
This quaternion
Parameters
- array: ArrayLike<number>
  
  The array
- offset: number = 0
  
  The start offset of the array
Returns Quaternion
- Defined in math/Quaternion.ts:539

toArray

toArray(out: Float32Array | Float64Array | number[], outOffset?: number): void
Clone the value of this quaternion to an array.
Parameters
- out: Float32Array | Float64Array | number[]
  
  The array
- outOffset: number = 0
  
  The start offset of the array
Returns void
- Defined in math/Quaternion.ts:656

toEuler

toEuler(out: Vector3): Vector3
Get the euler of this quaternion.

Returns
Euler x->pitch y->yaw z->roll
Parameters
- out: Vector3
  
  The euler (in radians) as an output parameter
Returns Vector3
- Defined in math/Quaternion.ts:630

toYawPitchRoll

toYawPitchRoll(out: Vector3): Vector3
Get the euler of this quaternion.

Returns
Euler x->yaw y->pitch z->roll
Parameters
- out: Vector3
  
  The euler (in radians) as an output parameter
Returns Vector3
- Defined in math/Quaternion.ts:645

`Static` add

add(left: Quaternion, right: Quaternion, out: Quaternion): void
Determines the sum of two quaternions.
Parameters
- left: Quaternion
  
  The first quaternion to add
- right: Quaternion
  
  The second quaternion to add
- out: Quaternion
  
  The sum of two quaternions
Returns void
- Defined in math/Quaternion.ts:20

`Static` conjugate

conjugate(a: Quaternion, out: Quaternion): void
Calculate quaternion that contains conjugated version of the specified quaternion.
Parameters
- a: Quaternion
  
  The specified quaternion
- out: Quaternion
  
  The conjugate version of the specified quaternion
Returns void
- Defined in math/Quaternion.ts:56

`Static` dot

dot(left: Quaternion, right: Quaternion): number
Determines the dot product of two quaternions.

Returns
The dot product of two quaternions
Parameters
- left: Quaternion
  
  The first quaternion to dot
- right: Quaternion
  
  The second quaternion to dot
Returns number
- Defined in math/Quaternion.ts:70

`Static` equals

equals(left: Quaternion, right: Quaternion): boolean
Determines whether the specified quaternions are equals.

Returns
True if the specified quaternions are equals, false otherwise
Parameters
- left: Quaternion
  
  The first quaternion to compare
- right: Quaternion
  
  The second quaternion to compare
Returns boolean
- Defined in math/Quaternion.ts:80

`Static` invert

invert(a: Quaternion, out: Quaternion): void
Calculate the inverse of the specified quaternion.
Parameters
- a: Quaternion
  
  The quaternion whose inverse is to be calculated
- out: Quaternion
  
  The inverse of the specified quaternion
Returns void
- Defined in math/Quaternion.ts:207

`Static` lerp

lerp(start: Quaternion, end: Quaternion, t: number, out: Quaternion): void
Performs a linear blend between two quaternions.
Parameters
- start: Quaternion
  
  The first quaternion
- end: Quaternion
  
  The second quaternion
- t: number
  
  The blend amount where 0 returns start and 1 end
- out: Quaternion
  
  The result of linear blending between two quaternions
Returns void
- Defined in math/Quaternion.ts:227

`Static` multiply

multiply(left: Quaternion, right: Quaternion, out: Quaternion): void
Determines the product of two quaternions.
Parameters
- left: Quaternion
  
  The first quaternion to multiply
- right: Quaternion
  
  The second quaternion to multiply
- out: Quaternion
  
  The product of two quaternions
Returns void
- Defined in math/Quaternion.ts:34

`Static` normalize

normalize(a: Quaternion, out: Quaternion): void
Scales the specified quaternion magnitude to unit length.
Parameters
- a: Quaternion
  
  The specified quaternion
- out: Quaternion
  
  The normalized quaternion
Returns void
- Defined in math/Quaternion.ts:298

`Static` rotateX

rotateX(quaternion: Quaternion, rad: number, out: Quaternion): void
Calculate a quaternion that the specified quaternion rotate around X axis.
Parameters
- quaternion: Quaternion
  
  The specified quaternion
- rad: number
  
  The rotation angle in radians
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:368

`Static` rotateY

rotateY(quaternion: Quaternion, rad: number, out: Quaternion): void
Calculate a quaternion that the specified quaternion rotate around Y axis.
Parameters
- quaternion: Quaternion
  
  The specified quaternion
- rad: number
  
  The rotation angle in radians
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:387

`Static` rotateZ

rotateZ(quaternion: Quaternion, rad: number, out: Quaternion): void
Calculate a quaternion that the specified quaternion rotate around Z axis.
Parameters
- quaternion: Quaternion
  
  The specified quaternion
- rad: number
  
  The rotation angle in radians
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:406

`Static` rotationAxisAngle

rotationAxisAngle(axis: Vector3, rad: number, out: Quaternion): void
Calculate a quaternion rotates around an arbitrary axis.
Parameters
- axis: Vector3
  
  The axis
- rad: number
  
  The rotation angle in radians
- out: Quaternion
  
  The quaternion after rotate
Returns void
- Defined in math/Quaternion.ts:95

`Static` rotationEuler

rotationEuler(x: number, y: number, z: number, out: Quaternion): void
Calculate a quaternion rotates around x, y, z axis (pitch/yaw/roll).
Parameters
- x: number
  
  The radian of rotation around X (pitch)
- y: number
  
  The radian of rotation around Y (yaw)
- z: number
  
  The radian of rotation around Z (roll)
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:114

`Static` rotationMatrix3x3

rotationMatrix3x3(m: Matrix3, out: Quaternion): void
Calculate a quaternion from the specified 3x3 matrix.
Parameters
- m: Matrix3
  
  The specified 3x3 matrix
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:152

`Static` rotationX

rotationX(rad: number, out: Quaternion): void
Calculate a quaternion rotate around X axis.
Parameters
- rad: number
  
  The rotation angle in radians
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:316

`Static` rotationY

rotationY(rad: number, out: Quaternion): void
Calculate a quaternion rotate around Y axis.
Parameters
- rad: number
  
  The rotation angle in radians
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:333

`Static` rotationYawPitchRoll

rotationYawPitchRoll(yaw: number, pitch: number, roll: number, out: Quaternion): void
Calculate a quaternion from the specified yaw, pitch and roll angles.
Parameters
- yaw: number
  
  Yaw around the y axis in radians
- pitch: number
  
  Pitch around the x axis in radians
- roll: number
  
  Roll around the z axis in radians
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:125

`Static` rotationZ

rotationZ(rad: number, out: Quaternion): void
Calculate a quaternion rotate around Z axis.
Parameters
- rad: number
  
  The rotation angle in radians
- out: Quaternion
  
  The calculated quaternion
Returns void
- Defined in math/Quaternion.ts:350

`Static` scale

scale(a: Quaternion, s: number, out: Quaternion): void
Scale a quaternion by a given number.
Parameters
- a: Quaternion
  
  The quaternion
- s: number
  
  The given number
- out: Quaternion
  
  The scaled quaternion
Returns void
- Defined in math/Quaternion.ts:425

`Static` slerp

slerp(start: Quaternion, end: Quaternion, t: number, out: Quaternion): void
Performs a spherical linear blend between two quaternions.
Parameters
- start: Quaternion
  
  The first quaternion
- end: Quaternion
  
  The second quaternion
- t: number
  
  The blend amount where 0 returns start and 1 end
- out: Quaternion
  
  The result of spherical linear blending between two quaternions
Returns void
- Defined in math/Quaternion.ts:251

Generated using TypeDoc