Class Quaternion

A quaternion.

Hierarchy (View Summary)

Vector4
- Quaternion

Index

Constructors

constructor

Properties

Accessors

w x y z

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion
Constructs a new Quaternion.
Parameters
- x: number = 0
  The X component.
- y: number = 0
  The Y component.
- z: number = 0
  The Z component.
- w: number = 0
  The W component.
Returns Quaternion
Overrides Vector4.constructor
- Defined in source/math/quaternion.ts:17

Properties

k

k: number[] = ...

The components of the vector.

Accessors

w

get w(): number
Get the W component of the vector.

Returns number
The W component of the vector.
Inherited from Vector4.w
- Defined in source/math/vector4.ts:56
set w(value: number): void
Set the W component of the vector.
Parameters
- value: number
Returns void
Inherited from Vector4.w
- Defined in source/math/vector4.ts:62

x

get x(): number
Get the X component of the vector.

Returns number
The X component of the vector.
Inherited from Vector4.x
- Defined in source/math/vector4.ts:14
set x(value: number): void
Set the X component of the vector.
Parameters
- value: number
Returns void
Inherited from Vector4.x
- Defined in source/math/vector4.ts:20

y

get y(): number
Get the Y component of the vector.

Returns number
The Y component of the vector.
Inherited from Vector4.y
- Defined in source/math/vector4.ts:28
set y(value: number): void
Set the Y component of the vector.
Parameters
- value: number
Returns void
Inherited from Vector4.y
- Defined in source/math/vector4.ts:34

z

get z(): number
Get the Z component of the vector.

Returns number
The Z component of the vector.
Inherited from Vector4.z
- Defined in source/math/vector4.ts:42
set z(value: number): void
Set the Z component of the vector.
Parameters
- value: number
Returns void
Inherited from Vector4.z
- Defined in source/math/vector4.ts:48

Methods

add3

add3(vector: Readonly<Vector4>): this
Adds the XYZ components of another vector to this vector.
Parameters
- vector: Readonly<Vector4>
  The vector to add to this vector.
Returns this
This instance.
Inherited from Vector4.add3
- Defined in source/math/vector4.ts:119

add3XYZ

add3XYZ(x: number, y: number, z: number): this
Adds the XYZ components of another vector to this vector.
Parameters
- x: number
  The value to add to the X component.
- y: number
  The value to add to the Y component.
- z: number
  The value to add to the Z component.
Returns this
This instance.
Inherited from Vector4.add3XYZ
- Defined in source/math/vector4.ts:130

addMultiply3

addMultiply3(vector: Readonly<Vector4>, scale: number): this
Scales another vector and adds its XYZ components to this vector.
Parameters
- vector: Readonly<Vector4>
  The vector to add to this vector.
- scale: number
  The scaling to apply to the input vector.
Returns this
This instance.
Inherited from Vector4.addMultiply3
- Defined in source/math/vector4.ts:143

addMultiply3XYZ

addMultiply3XYZ(x: number, y: number, z: number, scale: number): this
Scales another vector and adds its XYZ components to this vector.
Parameters
- x: number
  The value to add to the X component.
- y: number
  The value to add to the Y component.
- z: number
  The value to add to the Z component.
- scale: number
  The scaling to apply to the input vector.
Returns this
This instance.
Inherited from Vector4.addMultiply3XYZ
- Defined in source/math/vector4.ts:155

clamp

clamp(floor: number, ceil: number): this
Clamps the components of the vector at the given boundary.
Parameters
- floor: number
  The lowest value to allow.
- ceil: number
  The largest value to allow.
Returns this
This instance.
Inherited from Vector4.clamp
- Defined in source/math/vector4.ts:283

divide3

divide3(vector: Readonly<Vector4>): this
Divides the XYZ components of this vector by another vector.
Parameters
- vector: Readonly<Vector4>
  The vector to divide this vector with.
Returns this
This instance.
Inherited from Vector4.divide3
- Defined in source/math/vector4.ts:225

divide3Scale

divide3Scale(scale: number): this
Divides the XYZ components of the vector by the given scale.
Parameters
- scale: number
  The scaling to apply to the vector.
Returns this
This instance.
Inherited from Vector4.divide3Scale
- Defined in source/math/vector4.ts:248

divide3XYZ

divide3XYZ(x: number, y: number, z: number): this
Divides the XYZ components of this vector by another vector.
Parameters
- x: number
  The value to divide the X component with.
- y: number
  The value to divide the Y component with.
- z: number
  The value to divide the Z component with.
Returns this
This instance.
Inherited from Vector4.divide3XYZ
- Defined in source/math/vector4.ts:236

invert

invert(): this
Invert the quaternion.

Returns this
This instance.
- Defined in source/math/quaternion.ts:212

invertAdd3

invertAdd3(): this
Inverts the direction of the vector.

Returns this
This instance.
Inherited from Vector4.invertAdd3
- Defined in source/math/vector4.ts:259

invertMultiply3

invertMultiply3(): this
Inverts the vectors scale.

Returns this
This instance.
Inherited from Vector4.invertMultiply3
- Defined in source/math/vector4.ts:270

lerp

lerp(vector: Readonly<Vector4>, t: number): this
Linearly moves this vector towards a target vector.
Parameters
- vector: Readonly<Vector4>
  The target vector.
- t: number
  The location on the scale, from 0 to 1.
Returns this
This instance.
Inherited from Vector4.lerp
- Defined in source/math/vector4.ts:317

multiply3

multiply3(vector: Readonly<Vector4>): this
Multiplies the XYZ components of this vector by another vector.
Parameters
- vector: Readonly<Vector4>
  The vector to multiply with this vector.
Returns this
This instance.
Inherited from Vector4.multiply3
- Defined in source/math/vector4.ts:190

multiply3Scale

multiply3Scale(scale: number): this
Multiplies the XYZ components of the vector by the given scale.
Parameters
- scale: number
  The scaling to apply to the vector.
Returns this
This instance.
Inherited from Vector4.multiply3Scale
- Defined in source/math/vector4.ts:213

multiply3XYZ

multiply3XYZ(x: number, y: number, z: number): this
Multiplies the XYZ components of this vector by another vector.
Parameters
- x: number
  The value to multiply with the X component.
- y: number
  The value to multiply with the Y component.
- z: number
  The value to multiply with the Z component.
Returns this
This instance.
Inherited from Vector4.multiply3XYZ
- Defined in source/math/vector4.ts:201

multiplyR

multiplyR(quaternion: Readonly<Quaternion>): this
Multiply with another quaternion from the right.
Parameters
- quaternion: Readonly<Quaternion>
  The quaternion to multiply with.
Returns this
This instance.
- Defined in source/math/quaternion.ts:224

normalize

normalize(): this
Normalize the quaternion.

Returns this
This instance.
- Defined in source/math/quaternion.ts:198

set

set(quaternion: Readonly<Quaternion>): this
Sets the quaternion to the values of another quaternion.
Parameters
- quaternion: Readonly<Quaternion>
  The quaternion to copy.
Returns this
This instance.
Overrides Vector4.set
- Defined in source/math/quaternion.ts:72

setEuler

setEuler(degrees: Readonly<Euler>): this
Sets the quaternion to a rotation in Euler angles.
Parameters
- degrees: Readonly<Euler>
  The rotation in Euler angles.
Returns this
This instance.
- Defined in source/math/quaternion.ts:147

setMatrix3

setMatrix3(matrix: Readonly<Matrix3>): this
Sets the quaternion to the rotation of the given matrix.
Parameters
- matrix: Readonly<Matrix3>
  The matrix describing the rotation of the quaternion.
Returns this
This instance.
- Defined in source/math/quaternion.ts:114

setValue

setValue(value: number): this
Sets all components of the quaternion to the given value.
Parameters
- value: number
  The value to assign to the components of the quaternion.
Returns this
This instance.
- Defined in source/math/quaternion.ts:85

setVector3

setVector3(axis: Readonly<Vector3>, degrees: number): this
Sets the quaternion to a rotation around an axis.
Parameters
- axis: Readonly<Vector3>
  The axis around which to rotate.
- degrees: number
  The rotation in degrees.
Returns this
This instance.
- Defined in source/math/quaternion.ts:172

setVector4

setVector4(vector: Readonly<Vector4>): this
Sets the quaternion to the components of a Vector4.
Parameters
- vector: Readonly<Vector4>
  The vector to copy.
Returns this
This instance.
- Defined in source/math/quaternion.ts:186

setXYZW

setXYZW(x: number, y: number, z?: number, w?: number): this
Sets the components of the quaternion to the given values.
Parameters
- x: number
  The X component for the quaternion.
- y: number
  The Y component for the quaternion.
- z: number = 0
  The Z component for the quaternion.
- w: number = 1
  The W component for the quaternion.
Returns this
This instance.
Overrides Vector4.setXYZW
- Defined in source/math/quaternion.ts:101

slerp

slerp(q1: Readonly<Quaternion>, q2: Readonly<Quaternion>, t: number): this
Performs spherical linear interpolation between two rotations, and sets this quaternion to the resulting rotation.
Parameters
- q1: Readonly<Quaternion>
  The initial rotation.
- q2: Readonly<Quaternion>
  The target rotation.
- t: number
  The location on the scale from 0 to 1.
Returns this
This instance.
- Defined in source/math/quaternion.ts:249

subtract3

subtract3(vector: Readonly<Vector4>): this
Subtracts the XYZ components of another vector from this vector.
Parameters
- vector: Readonly<Vector4>
  The vector to subtract from this vector.
Returns this
This instance.
Inherited from Vector4.subtract3
- Defined in source/math/vector4.ts:167

subtract3XYZ

subtract3XYZ(x: number, y: number, z: number): this
Subtracts the XYZ components of another vector from this vector.
Parameters
- x: number
  The value to subtract from the X component.
- y: number
  The value to subtract from the Y component.
- z: number
  The value to subtract from the Z component.
Returns this
This instance.
Inherited from Vector4.subtract3XYZ
- Defined in source/math/vector4.ts:178

`Static`fromEuler

fromEuler(degrees: Readonly<Euler>): Quaternion
Creates a new Quaternion from a rotation in Euler angles.
Parameters
- degrees: Readonly<Euler>
  The rotation in Euler angles.
Returns Quaternion
A new quaternion.
- Defined in source/math/quaternion.ts:35

`Static`fromMatrix3

fromMatrix3(matrix: Readonly<Matrix3>): Quaternion
Creates a new Quaternion from a rotation matrix.
Parameters
- matrix: Readonly<Matrix3>
  The matrix to construct the quaternion from.
Returns Quaternion
A new quaternion.
- Defined in source/math/quaternion.ts:26

`Static`fromQuaternion

fromQuaternion(quaternion: Readonly<Quaternion>): Quaternion
Creates a new Quaternion from another Quaternion.
Parameters
- quaternion: Readonly<Quaternion>
  The quaternion to copy.
Returns Quaternion
A new quaternion.
- Defined in source/math/quaternion.ts:63

`Static`fromVector3

fromVector3(axis: Readonly<Vector3>, degrees: number): Quaternion
Creates a new Quaternion from a rotation around an axis.
Parameters
- axis: Readonly<Vector3>
  The axis around which to rotate.
- degrees: number
  The rotation in degrees.
Returns Quaternion
A new quaternion.
- Defined in source/math/quaternion.ts:45

`Static`fromVector4

fromVector4(vector: Readonly<Vector4>): Quaternion
Creates a new Quaternion from a Vector4.
Parameters
- vector: Readonly<Vector4>
  The vector to copy the components from.
Returns Quaternion
A new quaternion.
Overrides Vector4.fromVector4
- Defined in source/math/quaternion.ts:54

Class Quaternion

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Quaternion

Properties

k

Accessors

w

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

z

Returns number

Parameters

Returns void

Methods

add3

Parameters

Returns this

add3XYZ

Parameters

Returns this

addMultiply3

Parameters

Returns this

addMultiply3XYZ

Parameters

Returns this

clamp

Parameters

Returns this

divide3

Parameters

Returns this

divide3Scale

Parameters

Returns this

divide3XYZ

Parameters

Returns this

invert

Returns this

invertAdd3

Returns this

invertMultiply3

Returns this

lerp

Parameters

Returns this

multiply3

Parameters

Returns this

multiply3Scale

Parameters

Returns this

multiply3XYZ

Parameters

Returns this

multiplyR

Parameters

Returns this

normalize

Returns this

set

Parameters

`Static`fromEuler

`Static`fromMatrix3

`Static`fromQuaternion

`Static`fromVector3

`Static`fromVector4