Class Quaternion

Implementation of a quaternion. This is used for rotating things without incurring in the dreaded gimbal lock issue, amongst other advantages.

example: var quaternion = new THREE.Quaternion(); quaternion.setFromAxisAngle( new THREE.Vector3( 0, 1, 0 ), Math.PI / 2 ); var vector = new THREE.Vector3( 1, 0, 0 ); vector.applyQuaternion( quaternion );

Hierarchy

Quaternion

Index

Constructors

constructor

Properties

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion

- Defined in RuntimeFull.ts:1430
Parameters
- Optional x: number
  
  x coordinate
- Optional y: number
  
  y coordinate
- Optional z: number
  
  z coordinate
- Optional w: number
  
  w coordinate
Returns Quaternion

Properties

onChangeCallback

onChangeCallback: Function

w

w: number

x

x: number

y

y: number

z

z: number

Methods

clone

clone(): this

- Defined in RuntimeFull.ts:1452
Clones this quaternion.

Returns this

conjugate

conjugate(): Quaternion

- Defined in RuntimeFull.ts:1481
Returns Quaternion

copy

copy(q: this): this

- Defined in RuntimeFull.ts:1457
Copies values of q to this quaternion.

Parameters
- q: this
Returns this

dot

dot(v: Quaternion): number

- Defined in RuntimeFull.ts:1482
Parameters
- v: Quaternion
Returns number

equals

equals(v: Quaternion): boolean

- Defined in RuntimeFull.ts:1509
Parameters
- v: Quaternion
Returns boolean

fromArray

fromArray(n: number[]): Quaternion
fromArray(xyzw: number[], offset?: number): Quaternion

- Defined in RuntimeFull.ts:1510
Parameters
- n: number[]
Returns Quaternion
- Defined in RuntimeFull.ts:1513
Parameters
- xyzw: number[]
- Optional offset: number
Returns Quaternion

inverse

inverse(): Quaternion

- Defined in RuntimeFull.ts:1479
Inverts this quaternion.

Returns Quaternion

length

length(): number

- Defined in RuntimeFull.ts:1488
Computes length of this quaternion.

Returns number

lengthSq

lengthSq(): number

- Defined in RuntimeFull.ts:1483
Returns number

multiply

multiply(q: Quaternion): Quaternion

- Defined in RuntimeFull.ts:1498
Multiplies this quaternion by b.

Parameters
- q: Quaternion
Returns Quaternion

multiplyQuaternions

multiplyQuaternions(a: Quaternion, b: Quaternion): Quaternion

- Defined in RuntimeFull.ts:1505
Sets this quaternion to a x b Adapted from http://www.euclideanspace.com/maths/algebra/realNormedAlgebra/quaternions/code/index.htm.

Parameters
- a: Quaternion
- b: Quaternion
Returns Quaternion

multiplyVector3

multiplyVector3(v: any): any

- Defined in RuntimeFull.ts:1529
deprecated

Use {@link Vector#applyQuaternion vector.applyQuaternion( quaternion )} instead.

Parameters
- v: any
Returns any

normalize

normalize(): Quaternion

- Defined in RuntimeFull.ts:1493
Normalizes this quaternion.

Returns Quaternion

onChange

onChange(callback: Function): Quaternion

- Defined in RuntimeFull.ts:1516
Parameters
- callback: Function
Returns Quaternion

premultiply

premultiply(q: Quaternion): Quaternion

- Defined in RuntimeFull.ts:1499
Parameters
- q: Quaternion
Returns Quaternion

set

set(x: number, y: number, z: number, w: number): Quaternion

- Defined in RuntimeFull.ts:1447
Sets values of this quaternion.

Parameters
- x: number
- y: number
- z: number
- w: number
Returns Quaternion

setFromAxisAngle

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

- Defined in RuntimeFull.ts:1469
Sets this quaternion from rotation specified by axis and angle. Adapted from http://www.euclideanspace.com/maths/geometry/rotations/conversions/angleToQuaternion/index.htm. Axis have to be normalized, angle is in radians.

Parameters
- axis: Vector3
- angle: number
Returns Quaternion

setFromEuler

setFromEuler(euler: Euler, update?: boolean): Quaternion

- Defined in RuntimeFull.ts:1462
Sets this quaternion from rotation specified by Euler angles.

Parameters
- euler: Euler
- Optional update: boolean
Returns Quaternion

setFromRotationMatrix

setFromRotationMatrix(m: Matrix4): Quaternion

- Defined in RuntimeFull.ts:1474
Sets this quaternion from rotation component of m. Adapted from http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm.

Parameters
- m: Matrix4
Returns Quaternion

setFromUnitVectors

setFromUnitVectors(vFrom: Vector3, vTo: Vector3): Quaternion

- Defined in RuntimeFull.ts:1475
Parameters
- vFrom: Vector3
- vTo: Vector3
Returns Quaternion

slerp

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

- Defined in RuntimeFull.ts:1508
Parameters
- qb: Quaternion
- t: number
Returns Quaternion

toArray

toArray(): number[]
toArray(xyzw?: number[], offset?: number): number[]

- Defined in RuntimeFull.ts:1511
Returns number[]
- Defined in RuntimeFull.ts:1514
Parameters
- Optional xyzw: number[]
- Optional offset: number
Returns number[]

Static slerp

slerp(qa: Quaternion, qb: Quaternion, qm: Quaternion, t: number): Quaternion

- Defined in RuntimeFull.ts:1522
Adapted from http://www.euclideanspace.com/maths/algebra/realNormedAlgebra/quaternions/slerp/.

Parameters
- qa: Quaternion
- qb: Quaternion
- qm: Quaternion
- t: number
Returns Quaternion

Static slerpFlat

slerpFlat(dst: number[], dstOffset: number, src0: number[], srcOffset: number, src1: number[], stcOffset1: number, t: number): Quaternion

- Defined in RuntimeFull.ts:1524
Parameters
- dst: number[]
- dstOffset: number
- src0: number[]
- srcOffset: number
- src1: number[]
- stcOffset1: number
- t: number
Returns Quaternion

Generated using TypeDoc