Class Quaternion

A Quaternion.

Index

Constructors

Properties

Accessors

exp inversed length lengthSq log logVec3 matrix4 normalized w x y z identity

Methods

clone multiply nlerp slerp toString fromAxisAngle fromMatrix4 lookRotation multiply nlerp rotationX rotationY rotationZ slerp

Constructors

constructor

new Quaternion(elements?: RawQuaternion): Quaternion
Parameters
- elements: RawQuaternion = rawIdentityQuaternion
Returns Quaternion
- Defined in math/quat/Quaternion.ts:30

Properties

elements

elements: RawQuaternion

Accessors

exp

get exp(): Quaternion
An exponential map of this.

Returns Quaternion
- Defined in math/quat/Quaternion.ts:111

inversed

get inversed(): Quaternion
An inverse of this.

Returns Quaternion
- Defined in math/quat/Quaternion.ts:83

length

get length(): number
The length of this.

Returns number
- Defined in math/quat/Quaternion.ts:90

lengthSq

get lengthSq(): number
The squared length of this.

Returns number
- Defined in math/quat/Quaternion.ts:97

log

get log(): Quaternion
A logarithm map of this.

Returns Quaternion
- Defined in math/quat/Quaternion.ts:118

logVec3

get logVec3(): Vector3
A logarithm map of this as a Vector3.

Returns Vector3
- Defined in math/quat/Quaternion.ts:125

matrix4

get matrix4(): Matrix4
Itself but converted into a Matrix4.

Returns Matrix4
- Defined in math/quat/Quaternion.ts:76

normalized

get normalized(): Quaternion
A normalized this.

Returns Quaternion
- Defined in math/quat/Quaternion.ts:104

w

get w(): number
An w component of this.

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

x

get x(): number
An x component of this.

Returns number
- Defined in math/quat/Quaternion.ts:37

y

get y(): number
An y component of this.

Returns number
- Defined in math/quat/Quaternion.ts:44

z

get z(): number
An z component of this.

Returns number
- Defined in math/quat/Quaternion.ts:51

`Static`identity

get identity(): Quaternion
An identity Quaternion.

Returns Quaternion
- Defined in math/quat/Quaternion.ts:165

Methods

clone

clone(): Quaternion
Clone this.

Returns Quaternion
- Defined in math/quat/Quaternion.ts:69

multiply

multiply(...quaternions: Quaternion[]): Quaternion
Multiply one or more Quaternions with this.
Parameters
- ...quaternions: Quaternion[]
  Other Quaternions
Returns Quaternion
- Defined in math/quat/Quaternion.ts:133

nlerp

nlerp(b: Quaternion, t: number): Quaternion
Interpolate between this and given quaternion using normalized lerp. When the dot product of the two quaternions is negative, the given quaternion is negated to ensure the shortest path is taken.

This should behave the same as Unity's Quaternion.LerpUnclamped.
Parameters
- b: Quaternion
  "to" quaternion
- t: number
  How much do we want to rotate this to b
Returns Quaternion
The interpolated quaternion
- Defined in math/quat/Quaternion.ts:147

slerp

slerp(b: Quaternion, t: number): Quaternion
Interpolate between this and given quaternion using spherical lerp.
Parameters
- b: Quaternion
  Another Quaternion
- t: number
  How much do we want to rotate this to b
Returns Quaternion
The interpolated quaternion
- Defined in math/quat/Quaternion.ts:158

toString

toString(): string
Returns string
- Defined in math/quat/Quaternion.ts:62

`Static`fromAxisAngle

fromAxisAngle(axis: Vector3, angle: number): Quaternion
Generate a Quaternion out of angle and axis.
Parameters
- axis: Vector3
- angle: number
Returns Quaternion
- Defined in math/quat/Quaternion.ts:246

`Static`fromMatrix4

fromMatrix4(matrix: Matrix4): Quaternion
Generate a Quaternion out of a rotation matrix.
Parameters
- matrix: Matrix4
Returns Quaternion
- Defined in math/quat/Quaternion.ts:253

`Static`lookRotation

lookRotation(look: Vector3, up: Vector3): Quaternion
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
- Defined in math/quat/Quaternion.ts:239

`Static`multiply

multiply(...quaternions: Quaternion[]): Quaternion
Multiply two or more quaternions.
Parameters
- ...quaternions: Quaternion[]
Returns Quaternion
- Defined in math/quat/Quaternion.ts:173

`Static`nlerp

nlerp(a: Quaternion, b: Quaternion, t: number): Quaternion
Interpolate between two quaternions using normalized lerp. When the dot product of the two quaternions is negative, the second quaternion is negated to ensure the shortest path is taken.

This should behave the same as Unity's Quaternion.LerpUnclamped.
Parameters
- a: Quaternion
  "from" quaternion
- b: Quaternion
  "to" quaternion
- t: number
  How much do we want to rotate the a to b
Returns Quaternion
The interpolated quaternion
- Defined in math/quat/Quaternion.ts:194

`Static`rotationX

rotationX(theta: number): Quaternion
Return a quaternion which rotates around x axis.
Parameters
- theta: number
  An angle around x axis, in degree
Returns Quaternion
- Defined in math/quat/Quaternion.ts:214

`Static`rotationY

rotationY(theta: number): Quaternion
Return a quaternion which rotates around y axis.
Parameters
- theta: number
  An angle around y axis, in degree
Returns Quaternion
- Defined in math/quat/Quaternion.ts:222

`Static`rotationZ

rotationZ(theta: number): Quaternion
Return a quaternion which rotates around z axis.
Parameters
- theta: number
  An angle around z axis, in degree
Returns Quaternion
- Defined in math/quat/Quaternion.ts:230

`Static`slerp

slerp(a: Quaternion, b: Quaternion, t: number): Quaternion
Interpolate between two quaternions using spherical lerp.
Parameters
- a: Quaternion
  "from" quaternion
- b: Quaternion
  "to" quaternion
- t: number
  How much do we want to rotate the a to b
Returns Quaternion
The interpolated quaternion
- Defined in math/quat/Quaternion.ts:206