OpenGlobus v1.0.0-rc27

Quat

Source: Quat.ts:21

A set of 4-dimensional coordinates used to represent rotation in 3-dimensional space.

Constructor

new Quat(x?: Number, y?: Number, z?: Number, w?: Number): Quat

Parameters

  • x (Number, optional, default: "0.0") — The X component.
  • y (Number, optional, default: "0.0") — The Y component.
  • z (Number, optional, default: "0.0") — The Z component.
  • w (Number, optional, default: "0.0") — The W component.

Instance Methods

isZero(): boolean

Quat.ts:234

Returns true if the components are zero.

Returns

  • boolean

isNaN(): boolean

Quat.ts:243

Returns true if a component is NaN.

Returns

  • boolean

clear(): Quat

Quat.ts:252

Clear Quat. Sets zeroes.

Returns

set(x?: Number, y?: Number, z?: Number, w?: Number): Quat

Quat.ts:266

Sets Quat values.

Parameters

  • x (Number, optional, default: "0.0") — The X component.
  • y (Number, optional, default: "0.0") — The Y component.
  • z (Number, optional, default: "0.0") — The Z component.
  • w (Number, optional, default: "0.0") — The W component.

Returns

copy(q: Quat): Quat

Quat.ts:280

Copy Quat values.

Parameters

  • q (Quat) — Copy Quat.

Returns

setIdentity(): Quat

Quat.ts:293

Set current Quat instance to identity Quat.

Returns

clone(): Quat

Quat.ts:306

Duplicates a Quat instance.

Returns

add(q: Quat): Quat

Quat.ts:316

Computes the componentwise sum of two Quats.

Parameters

  • q (Quat) — Quat to add.

Returns

addRes(q: Quat, res: Quat): Quat

Quat.ts:327

Computes the componentwise sum of two Quats.

Parameters

  • q (Quat) — Quat to add.
  • res (Quat) — Output quaternion.

Returns

  • Quat — Result quaternion.

sub(q: Quat): Quat

Quat.ts:337

Computes the componentwise difference of two Quats.

Parameters

  • q (Quat) — Quat to subtract.

Returns

scaleTo(scale: Number): Quat

Quat.ts:347

Multiplies the provided Quat componentwise by the provided scalar.

Parameters

  • scale (Number) — The scalar to multiply with.

Returns

scale(scale: Number): Quat

Quat.ts:357

Multiplies the provided Quat componentwise.

Parameters

  • scale (Number) — The scalar to multiply with.

Returns

toVec(): Array.<number>

Quat.ts:370

Converts Quat values to array.

Returns

  • Array.<number>

setLookRotation(forward: Vec3, up: Vec3): Quat

Quat.ts:385

Sets rotation with the given heading and up vectors.

Parameters

  • forward (Vec3) — Heading target coordinates.
  • up (Vec3) — Up vector.

Returns

setFromSphericalCoords( lat: number, lon: number, angle: number, ): Quat

Quat.ts:428

Sets current quaternion by spherical coordinates.

Parameters

  • lat (number) — Latitude.
  • lon (number) — Longitude.
  • angle (number) — Angle in radians.

Returns

getSphericalCoords(): Object

Quat.ts:449

Gets spherical coordinates.

Returns

  • Object — Returns object with latitude, longitude and alpha.

setFromAxisAngle(axis: Vec3, angle: number): Quat

Quat.ts:489

Sets current Quat representing a rotation around an axis.

Parameters

  • axis (Vec3) — The axis of rotation.
  • angle (number) — The angle in radians to rotate around the axis.

Returns

getAxisAngle(): QuatAxisAngle

Quat.ts:508

Returns axis and angle of the current Quat.

Returns

_sinPitch(): number

protected
Quat.ts:539

Sine of the pitch angle - the shared term of the euler decomposition below.

Returns

  • number

_atEulerPole(): boolean

protected
Quat.ts:549

True when the rotation looks straight up or down (gimbal lock): the getters then return roll 0 and put the whole turn into yaw.

Returns

  • boolean

setFromEulerAngles( pitch: number, yaw: number, roll: number, ): Quat

Quat.ts:593

Sets current Quat by Euler's angles.

Parameters

  • pitch (number) — Pitch angle in degrees.
  • yaw (number) — Yaw angle in degrees.
  • roll (number) — Roll angle in degrees.

Returns

getEulerAngles(): Object

Quat.ts:622

Returns Euler's angles of the current Quat.

Returns

  • Object

setFromMatrix4(mx: Mat4): Quat

Quat.ts:656

Computes a Quat from the provided 4x4 matrix instance.

Parameters

  • mx (Mat4) — The rotation matrix.

Returns

getMat4(out?: Mat4): Mat4

Quat.ts:705

Converts current Quat to the rotation 4x4 matrix.

Parameters

  • out (Mat4, optional) — Output matrix.

Returns

getMat3(): Mat3

Quat.ts:745

Converts current Quat to the rotation 3x3 matrix.

Returns

  • TODO:
    • NOT TESTED

mulVec3(v: Vec3): Vec3

Quat.ts:787

Returns quaternion and vector production.

Parameters

  • v (Vec3) — 3d Vector.

Returns

mulVec3Res(v: Vec3, res: Vec3): Vec3

Quat.ts:820

Returns quaternion and vector production.

Parameters

  • v (Vec3) — 3d Vector.
  • res (Vec3) — result output vector.

Returns

mul(q: Quat): Quat

Quat.ts:903

Computes the product of two Quats.

Parameters

  • q (Quat) — Quat to multiply.

Returns

mulRes(q: Quat, res: Quat): Quat

Quat.ts:878

Computes the product of two Quats.

Parameters

  • q (Quat) — Quat to multiply.
  • res (Quat) — Output quaternion.

Returns

  • Quat — Result quaternion.

mulA(q: Quat): Quat

Quat.ts:903

Computes the product of two Quats.

Parameters

  • q (Quat) — Quat to multiply.

Returns

conjugate(): Quat

Quat.ts:927

Returns the conjugate of the current quaternion.

Returns

inverse(): Quat

Quat.ts:936

Computes the inverse of the Quat.

Returns

magnitude(): number

Quat.ts:946

Computes a magnitude of the Quat.

Returns

  • number

magnitude2(): number

Quat.ts:959

Computes a squared magnitude of the Quat.

Returns

  • number

dot(q: Quat): number

Quat.ts:973

Computes the dot (scalar) product of two Quats.

Parameters

  • q (Quat) — Second quaternion.

Returns

  • number

normalize(): Quat

Quat.ts:982

Current Quat normalization.

Returns

isEqual(q: Quat): Boolean

Quat.ts:1012

Compares two Quats.

Parameters

  • q (Quat) — Second quaternion.

Returns

  • Boolean

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

Quat.ts:1024

Performs a spherical linear interpolation between two Quats.

Parameters

  • b (Quat) — The end rotation Quat.
  • t (number) — interpolation amount between the two Quats.

Returns

Static Methods

xRotation(a: number): Quat

static
Quat.ts:76

Returns a Quat represents rotation around X axis.

Parameters

  • a (number) — The angle in radians to rotate around the axis.

Returns

yRotation(a: number): Quat

static
Quat.ts:87

Returns a Quat represents rotation around Y axis.

Parameters

  • a (number) — The angle in radians to rotate around the axis.

Returns

zRotation(a: number): Quat

static
Quat.ts:98

Returns a Quat represents rotation around Z axis.

Parameters

  • a (number) — The angle in radians to rotate around the axis.

Returns

axisAngleToQuat(axis: Vec3, angle?: number): Quat

static
Quat.ts:110

Computes a Quat representing a rotation around an axis.

Parameters

  • axis (Vec3) — The axis of rotation.
  • angle (number, optional, default: "0.0") — The angle in radians to rotate around the axis.

Returns

getLookRotation(forward: Vec3, up: Vec3): Quat

static
Quat.ts:124

Computes a rotation from the given heading and up vector.

Parameters

  • forward (Vec3) — Heading target coordinates.
  • up (Vec3) — Up vector.

Returns

getLookAtSourceDest(sourcePoint: Vec3, destPoint: Vec3): Quat

static
Quat.ts:156

Computes a Quat from source point heading to the destination point.

Parameters

  • sourcePoint (Vec3) — Source coordinate.
  • destPoint (Vec3) — Destination coordinate.

Returns

getRotationBetweenVectors(u: Vec3, v: Vec3): Quat

static
Quat.ts:177

Computes rotation between two vectors.

Parameters

  • u (Vec3) — First vector.
  • v (Vec3) — Second vector.

Returns

getRotationBetweenVectorsRes(u: Vec3, v: Vec3, res: Quat): Quat

static
Quat.ts:191

Computes rotation between two vectors.

Parameters

  • u (Vec3) — First vector.
  • v (Vec3) — Second vector.
  • res (Quat) — Output quaternion.

Returns

getRotationBetweenVectorsUp( source: Vec3, dest: Vec3, up: Vec3, ): Quat

static
Quat.ts:207

Computes rotation between two vectors. Uses the up vector when vectors are exactly opposite. Returns identity when vectors are exactly equal.

Parameters

  • source (Vec3) — First vector.
  • dest (Vec3) — Second vector.
  • up (Vec3) — Up vector.

Returns

Other

IDENTITY: Quat

static
Quat.ts:66

Identity Quat.