Class Quaternion

Hierarchy

Quaternion
- Quaternion

Constructors

constructor

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

Overrides THREE.Quaternion.constructor
- Defined in src/anigraph/amath/Quaternion.ts:15
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
- w: number = 1
Returns Quaternion

Properties

_onChangeCallback

_onChangeCallback: () => void

Type declaration

- (): void
- Returns void

Protected _w

_w: number

Protected _x

_x: number

Protected _y

_y: number

Protected _z

_z: number

Readonly isQuaternion

isQuaternion: true

w

w: number

default: 1

x

x: number

default: 0

y

y: number

default: 0

z

z: number

default: 0

Accessors

Vec4

get Vec4(): Vec4

- Defined in src/anigraph/amath/Quaternion.ts:43
Returns Vec4

Methods

Mat3

Mat3(): Mat3

- Defined in src/anigraph/amath/Quaternion.ts:133
Returns Mat3

Mat4

Mat4(): Mat4

- Defined in src/anigraph/amath/Quaternion.ts:161
Returns Mat4

_onChange

_onChange(callback: () => void): Quaternion

Inherited from THREE.Quaternion._onChange
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:139
Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns Quaternion

angleTo

angleTo(q: Quaternion): number

Inherited from THREE.Quaternion.angleTo
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:76
Parameters
- q: Quaternion
Returns number

appliedTo

appliedTo(v: Vec3): Vec3

- Defined in src/anigraph/amath/Quaternion.ts:47
Parameters
- v: Vec3
Returns Vec3

clone

clone(): Quaternion

Inherited from THREE.Quaternion.clone
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:52
Clones this quaternion.

Returns Quaternion

conjugate

conjugate(): Quaternion

Inherited from THREE.Quaternion.conjugate
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:86
Returns Quaternion

copy

copy(q: Quaternion): Quaternion

Inherited from THREE.Quaternion.copy
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:57
Copies values of q to this quaternion.

Parameters
- q: Quaternion
Returns Quaternion

dot

dot(v: Quaternion): number

Inherited from THREE.Quaternion.dot
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:87
Parameters
- v: Quaternion
Returns number

equals

equals(v: Quaternion): boolean

Inherited from THREE.Quaternion.equals
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:114
Parameters
- v: Quaternion
Returns boolean

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): Quaternion

Inherited from THREE.Quaternion.fromArray
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:121
Sets this quaternion's x, y, z and w value from the provided array or array-like.

Parameters
- array: number[] | ArrayLike<number>
  
  the source array or array-like.
- Optional offset: number
  
  (optional) offset into the array. Default is 0.
Returns Quaternion

getAxisAndAngle

getAxisAndAngle(): { angle: number; axis: Vec3 }

- Defined in src/anigraph/amath/Quaternion.ts:241
Returns { angle: number; axis: Vec3 }
- angle: number
- axis: Vec3

getInverse

getInverse(): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:77
Returns Quaternion

identity

identity(): Quaternion

Inherited from THREE.Quaternion.identity
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:79
Returns Quaternion

inverse

inverse(): Quaternion

Inherited from THREE.Quaternion.inverse
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:169
deprecated
Use {@link Quaternion#invert .invert()} instead.

Returns Quaternion

invert

invert(): Quaternion

Inherited from THREE.Quaternion.invert
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:84
Inverts this quaternion.

Returns Quaternion

isEqualTo

isEqualTo(other: Quaternion, tolerance?: number): boolean

- Defined in src/anigraph/amath/Quaternion.ts:68
Return true if each element is within precision of its counterpart

Parameters
- other: Quaternion
- Optional tolerance: number
Returns boolean

length

length(): number

Inherited from THREE.Quaternion.length
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:93
Computes length of this quaternion.

Returns number

lengthSq

lengthSq(): number

Inherited from THREE.Quaternion.lengthSq
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:88
Returns number

multiply

multiply(q: Quaternion): Quaternion

Inherited from THREE.Quaternion.multiply
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:103
Multiplies this quaternion by b.

Parameters
- q: Quaternion
Returns Quaternion

multiplyQuaternions

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

Inherited from THREE.Quaternion.multiplyQuaternions
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:110
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

Inherited from THREE.Quaternion.multiplyVector3
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:164
deprecated
Use {@link Vector#applyQuaternion vector.applyQuaternion( quaternion )} instead.

Parameters
- v: any
Returns any

normalize

normalize(): Quaternion

Overrides THREE.Quaternion.normalize
- Defined in src/anigraph/amath/Quaternion.ts:38
Returns Quaternion

premultiply

premultiply(q: Quaternion): Quaternion

Inherited from THREE.Quaternion.premultiply
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:104
Parameters
- q: Quaternion
Returns Quaternion

randomize

randomize(): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:83
Returns Quaternion

rotateTowards

rotateTowards(q: Quaternion, step: number): Quaternion

Inherited from THREE.Quaternion.rotateTowards
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:77
Parameters
- q: Quaternion
- step: number
Returns Quaternion

set

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

Inherited from THREE.Quaternion.set
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:47
Sets values of this quaternion.

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

setFromAxisAngle

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

Inherited from THREE.Quaternion.setFromAxisAngle
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:69
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

Inherited from THREE.Quaternion.setFromEuler
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:62
Sets this quaternion from rotation specified by Euler angles.

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

setFromRotationMatrix

setFromRotationMatrix(m: Matrix4): Quaternion

Inherited from THREE.Quaternion.setFromRotationMatrix
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:74
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

Inherited from THREE.Quaternion.setFromUnitVectors
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:75
Parameters
- vFrom: Vector3
- vTo: Vector3
Returns Quaternion

slerp

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

Inherited from THREE.Quaternion.slerp
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:112
Parameters
- qb: Quaternion
- t: number
Returns Quaternion

slerpQuaternions

slerpQuaternions(qa: Quaternion, qb: Quaternion, t: number): Quaternion

Inherited from THREE.Quaternion.slerpQuaternions
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:113
Parameters
- qa: Quaternion
- qb: Quaternion
- t: number
Returns Quaternion

times

times(q: Quaternion | Mat3 | Mat4): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:51
Parameters
- q: Quaternion | Mat3 | Mat4
Returns Quaternion

toArray

toArray(array?: number[], offset?: number): number[]
toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>

Inherited from THREE.Quaternion.toArray
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:129
Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.

Parameters
- Optional array: number[]
  
  (optional) array to store the quaternion to. If this is not provided, a new array will be created.
- Optional offset: number
  
  (optional) optional offset into the array.
Returns number[]
The created or provided array.
Inherited from THREE.Quaternion.toArray
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:137
Copies x, y, z and w into the provided array-like.

Parameters
- array: ArrayLike<number>
  
  array-like to store the quaternion to.
- Optional offset: number
  
  (optional) optional offset into the array.
Returns ArrayLike<number>
The provided array-like.

Static FromAxisAngle

FromAxisAngle(axis: Vec3 | Vector3, angle: number): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:230
Parameters
- axis: Vec3 | Vector3
- angle: number
Returns Quaternion

Static FromMatrix

FromMatrix(m: Mat3 | Mat4 | Matrix4): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:106
Parameters
- m: Mat3 | Mat4 | Matrix4
Returns Quaternion

Static FromQuaternion

FromQuaternion(q: Quaternion): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:24
Parameters
- q: Quaternion
Returns Quaternion

Static FromRotationBetweenTwoVectors

FromRotationBetweenTwoVectors(vFrom: Vec3 | Vector3, vTo: Vec3 | Vector3): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:253
Parameters
- vFrom: Vec3 | Vector3
- vTo: Vec3 | Vector3
Returns Quaternion

Static FromVectors

FromVectors(forward: Vec3, up: Vec3): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:118
Parameters
- forward: Vec3
- up: Vec3
Returns Quaternion

Static Identity

Identity(): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:217
Returns Quaternion

Static Random

Random(): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:269
Returns Quaternion

Static RotationX

RotationX(radians: number): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:28
Parameters
- radians: number
Returns Quaternion

Static RotationY

RotationY(radians: number): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:31
Parameters
- radians: number
Returns Quaternion

Static RotationZ

RotationZ(radians: number): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:34
Parameters
- radians: number
Returns Quaternion

Static Slerp

Slerp(qa: Quaternion, qb: Quaternion, t: number): Quaternion

- Defined in src/anigraph/amath/Quaternion.ts:224
Parameters
- qa: Quaternion
- qb: Quaternion
- t: number
Returns Quaternion

Static multiplyQuaternionsFlat

multiplyQuaternionsFlat(dst: number[], dstOffset: number, src0: number[], srcOffset: number, src1: number[], stcOffset1: number): number[]

Inherited from THREE.Quaternion.multiplyQuaternionsFlat
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:152
Parameters
- dst: number[]
- dstOffset: number
- src0: number[]
- srcOffset: number
- src1: number[]
- stcOffset1: number
Returns number[]

Static slerpFlat

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

Inherited from THREE.Quaternion.slerpFlat
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:142
Parameters
- dst: number[]
- dstOffset: number
- src0: number[]
- srcOffset: number
- src1: number[]
- stcOffset1: number
- t: number
Returns Quaternion

Generated using TypeDoc