Class Quaternion

A Quaternion.

Hierarchy

Quaternion

Index

Constructors

constructor

Properties

elements

Accessors

Methods

Constructors

constructor

new Quaternion(elements?: RawQuaternion): Quaternion

- Defined in math/quat/Quaternion.ts:26
Parameters
- elements: RawQuaternion = rawIdentityQuaternion
Returns Quaternion

Properties

elements

elements: RawQuaternion

Accessors

inversed

get inversed(): Quaternion

- Defined in math/quat/Quaternion.ts:79
An inverse of this.

Returns Quaternion

length

get length(): number

- Defined in math/quat/Quaternion.ts:86
The length of this.

Returns number

lengthSq

get lengthSq(): number

- Defined in math/quat/Quaternion.ts:93
The squared length of this.

Returns number

matrix4

get matrix4(): Matrix4

- Defined in math/quat/Quaternion.ts:72
Itself but converted into a Matrix4.

Returns Matrix4

normalized

get normalized(): Quaternion

- Defined in math/quat/Quaternion.ts:100
A normalized this.

Returns Quaternion

w

get w(): number

- Defined in math/quat/Quaternion.ts:54
An w component of this.

Returns number

x

get x(): number

- Defined in math/quat/Quaternion.ts:33
An x component of this.

Returns number

y

get y(): number

- Defined in math/quat/Quaternion.ts:40
An y component of this.

Returns number

z

get z(): number

- Defined in math/quat/Quaternion.ts:47
An z component of this.

Returns number

Static identity

get identity(): Quaternion

- Defined in math/quat/Quaternion.ts:124
An identity Quaternion.

Returns Quaternion

Methods

clone

clone(): Quaternion

- Defined in math/quat/Quaternion.ts:65
Clone this.

Returns Quaternion

multiply

multiply(...quaternions: Quaternion[]): Quaternion

- Defined in math/quat/Quaternion.ts:108
Multiply one or more Quaternions with this.

Parameters
- Rest ...quaternions: Quaternion[]
  
  Other Quaternions
Returns Quaternion

slerp

slerp(b: Quaternion, t: number): Quaternion

- Defined in math/quat/Quaternion.ts:117
Interpolate between this and given quaternion.

Parameters
- b: Quaternion
  
  Another Quaternion
- t: number
  
  How much do we want to rotate this to b
Returns Quaternion

toString

toString(): string

- Defined in math/quat/Quaternion.ts:58
Returns string

Static fromAxisAngle

fromAxisAngle(axis: Vector3, angle: number): Quaternion

- Defined in math/quat/Quaternion.ts:186
Generate a Quaternion out of angle and axis.

Parameters
- axis: Vector3
- angle: number
Returns Quaternion

Static fromMatrix4

fromMatrix4(matrix: Matrix4): Quaternion

- Defined in math/quat/Quaternion.ts:193
Generate a Quaternion out of a rotation matrix.

Parameters
- matrix: Matrix4
Returns Quaternion

Static lookRotation

lookRotation(look: Vector3, up: Vector3): Quaternion

- Defined in math/quat/Quaternion.ts:179
Return a quaternion which looks at the direction of look.

Parameters
- look: Vector3
  
  Position where the quaternion will look at
- up: Vector3
  
  The "up vector"
Returns Quaternion

Static multiply

multiply(...quaternions: Quaternion[]): Quaternion

- Defined in math/quat/Quaternion.ts:132
Multiply two or more matrices.

Parameters
- Rest ...quaternions: Quaternion[]
Returns Quaternion

Static rotationX

rotationX(theta: number): Quaternion

- Defined in math/quat/Quaternion.ts:154
Return a quaternion which rotates around x axis.

Parameters
- theta: number
  
  An angle around x axis, in degree
Returns Quaternion

Static rotationY

rotationY(theta: number): Quaternion

- Defined in math/quat/Quaternion.ts:162
Return a quaternion which rotates around y axis.

Parameters
- theta: number
  
  An angle around y axis, in degree
Returns Quaternion

Static rotationZ

rotationZ(theta: number): Quaternion

- Defined in math/quat/Quaternion.ts:170
Return a quaternion which rotates around z axis.

Parameters
- theta: number
  
  An angle around z axis, in degree
Returns Quaternion

Static slerp

slerp(a: Quaternion, b: Quaternion, t: number): Quaternion

- Defined in math/quat/Quaternion.ts:146
Interpolate between two quaternions.

Parameters
- a: Quaternion
  
  "from" quaternion
- b: Quaternion
  
  "to" quaternion
- t: number
  
  How much do we want to rotate the a to b
Returns Quaternion

Generated using TypeDoc