openglobus

Class: Quat

Quat

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

new Quat(x, y, z, w)

og/math/Quat.js, line 16
Name Type Default Description
x Number 0.0 optional The X component.
y Number 0.0 optional The Y component.
z Number 0.0 optional The Z component.
w Number 0.0 optional The W component.

Classes

Quat

Members

static,constantQuat.IDENTITYQuat

Identity Quat.

wNumber

The W component.
Default Value:
  • 0.0

xNumber

The X component.
Default Value:
  • 0.0

yNumber

The Y component.
Default Value:
  • 0.0

zNumber

The Z component.
Default Value:
  • 0.0

Methods

staticQuat.axisAngleToQuat(axis, angle){Quat}

og/math/Quat.js, line 106
Computes a Quat representing a rotation around an axis.
Name Type Default Description
axis Vec3 The axis of rotation.
angle number 0.0 optional The angle in radians to rotate around the axis.
Returns:
Type Description
Quat -

staticQuat.getLookAtSourceDest(sourcePoint, destPoint){Quat}

og/math/Quat.js, line 154
Computes a Quat from from source point heading to the destination point.
Name Type Description
sourcePoint Vec3 Source coordinate.
destPoint Vec3 Destination coordinate.
Returns:
Type Description
Quat -

staticQuat.getLookRotation(forward, up){Quat}

og/math/Quat.js, line 121
Computes a rotation from the given heading and up vector.
Name Type Description
forward Vec3 Heading target coordinates.
up Vec3 Up vector.
Returns:
Type Description
Quat -

staticQuat.getRotationBetweenVectors(u, v){Quat}

og/math/Quat.js, line 175
Compute rotation between two vectors.
Name Type Description
u Vec3 First vector.
v Vec3 Second vector.
Returns:
Type Description
Quat -

staticQuat.getRotationBetweenVectorsRes(u, v, res){Quat}

og/math/Quat.js, line 189
Compute rotation between two vectors.
Name Type Description
u Vec3 First vector.
v Vec3 Second vector.
res Quat
Returns:
Type Description
Quat -

staticQuat.getRotationBetweenVectorsUp(source, dest, up){Quat}

og/math/Quat.js, line 205
Compute rotation between two vectors with around vector up for exactly opposite vectors. If vectors exaclty in the same direction than returns identity Quat.
Name Type Description
source Vec3 First vector.
dest Vec3 Second vector.
up Vec3 Up vector.
Returns:
Type Description
Quat -

staticQuat.xRotation(a){Quat}

og/math/Quat.js, line 72
Returns a Quat represents rotation around X axis.
Name Type Description
a number The angle in radians to rotate around the axis.
Returns:
Type Description
Quat -

staticQuat.yRotation(a){Quat}

og/math/Quat.js, line 83
Returns a Quat represents rotation around Y axis.
Name Type Description
a number The angle in radians to rotate around the axis.
Returns:
Type Description
Quat -

staticQuat.zRotation(a){Quat}

og/math/Quat.js, line 94
Returns a Quat represents rotation around Z axis.
Name Type Description
a number The angle in radians to rotate around the axis.
Returns:
Type Description
Quat -

add(q){Quat}

og/math/Quat.js, line 301
Computes the componentwise sum of two Quats.
Name Type Description
q Quat Quat to add.
Returns:
Type Description
Quat -

clear(){Quat}

og/math/Quat.js, line 237
Clear Quat. Sets zeroes.
Returns:
Type Description
Quat -

clone(){Quat}

og/math/Quat.js, line 291
Duplicates a Quat instance.
Returns:
Type Description
Quat -

conjugate(){Quat}

og/math/Quat.js, line 758
Gets the conjugate of the Quat.
Returns:
Type Description
Quat -

copy(q){Quat}

og/math/Quat.js, line 265
Copy Quat values.
Name Type Description
q Quat Copy Quat.
Returns:
Type Description
Quat -

dot(q){number}

og/math/Quat.js, line 804
Computes the dot (scalar) product of two Quats.
Name Type Description
q Quat Second quatrnion.
Returns:
Type Description
number -

getAxisAngle(){Object}

og/math/Quat.js, line 463
Returns axis and angle of the current Quat.
Returns:
Type Description
Object -

getEulerAngles(){Object}

og/math/Quat.js, line 522
Returns Euler's angles of the current Quat.
Returns:
Type Description
Object -

getMat3(){Mat3}

og/math/Quat.js, line 640
Converts current Quat to the rotation 3x3 matrix.
TODO
  • NOT TESTED
Returns:
Type Description
Mat3 -

getMat4(){Mat4}

og/math/Quat.js, line 600
Converts current Quat to the rotation 4x4 matrix.
Returns:
Type Description
Mat4 -

getPitch(reprojectAxis){number}

og/math/Quat.js, line 925
Returns a pitch angle in radians.
Name Type Description
reprojectAxis Boolean optional -
Returns:
Type Description
number -

getRoll(reprojectAxis){Number}

og/math/Quat.js, line 901
Returns a roll angle in radians.
Name Type Description
reprojectAxis Boolean optional -
Returns:
Type Description
Number -

getYaw(reprojectAxis){number}

og/math/Quat.js, line 949
Returns a yaw angle in radians.
Name Type Description
reprojectAxis Boolean optional -
Returns:
Type Description
number -

inverse(){Quat}

og/math/Quat.js, line 767
Computes the inverse of the Quat.
Returns:
Type Description
Quat -

isEqual(q){Boolean}

og/math/Quat.js, line 840
Compares two Quats.
Name Type Description
q Quat Second quatrnion.
Returns:
Type Description
Boolean -

isZero(q){Quat}

og/math/Quat.js, line 228
Returns true if the components are zero.
Name Type Description
q Quat Quat to subtract.
Returns:
Type Description
Quat -

magnitude(){number}

og/math/Quat.js, line 777
Computes a magnitude of the Quat.
Returns:
Type Description
number -

magnitude2(){number}

og/math/Quat.js, line 790
Computes a squared magnitude of the Quat.
Returns:
Type Description
number -

mul(q){Quat}

og/math/Quat.js, line 714
Computes the product of two Quats.
Name Type Description
q Quat Quat to multiply.
Returns:
Type Description
Quat -

mulA(q){Quat}

og/math/Quat.js, line 737
Computes the product of two Quats.
Name Type Description
q Quat Quat to multiply.
Returns:
Type Description
Quat -

mulVec3(v){Vec3}

og/math/Quat.js, line 682
Returns quatrenion and vector production.
Name Type Description
v Vec3 3d Vector.
Returns:
Type Description
Vec3 -

normalize(){Quat}

og/math/Quat.js, line 813
Current Quat normalization.
Returns:
Type Description
Quat -

scale(scale){Quat}

og/math/Quat.js, line 331
Multiplies the provided Quat componentwise.
Name Type Description
scale Number The scalar to multiply with.
Returns:
Type Description
Quat -

scaleTo(scale){Quat}

og/math/Quat.js, line 321
Multiplies the provided Quat componentwise by the provided scalar.
Name Type Description
scale Number The scalar to multiply with.
Returns:
Type Description
Quat -

set(x, y, z, w){Quat}

og/math/Quat.js, line 251
Sets Quat values.
Name Type Default Description
x Number 0.0 optional The X component.
y Number 0.0 optional The Y component.
z Number 0.0 optional The Z component.
w Number 0.0 optional The W component.
Returns:
Type Description
Quat -

setFromAxisAngle(axis, angle){Quat}

og/math/Quat.js, line 450
Sets current Quat representing a rotation around an axis.
Name Type Description
axis Vec3 The axis of rotation.
angle number The angle in radians to rotate around the axis.
Returns:
Type Description
Quat -

setFromEulerAngles(pitch, yaw, roll){Quat}

og/math/Quat.js, line 493
Sets current Quat by Euler's angles.
Name Type Description
pitch number Pitch angle in degrees.
yaw number Yaw angle in degrees.
roll number Roll angle in degrees.
Returns:
Type Description
Quat -

setFromMatrix4(m){Quat}

og/math/Quat.js, line 552
Computes a Quat from the provided 4x4 matrix instance.
Name Type Description
m Mat4 The rotation matrix.
Returns:
Type Description
Quat -

setFromSphericalCoords(lat, lon, angle){Quat}

og/math/Quat.js, line 356
Sets current quaternion by spherical coordinates.
Name Type Description
lat number Latitude.
lon number Longitude.
angle number Angle in radians.
Returns:
Type Description
Quat -

setIdentity(){Quat}

og/math/Quat.js, line 278
Set current Quat instance to identity Quat.
Returns:
Type Description
Quat -

setLookRotation(forward, up){Quat}

og/math/Quat.js, line 377
Sets rotation with the given heading and up vectors.
Name Type Description
forward Vec3 Heading target coordinates.
up Vec3 Up vector.
Returns:
Type Description
Quat -

slerp(b, t){Quat}

og/math/Quat.js, line 855
Performs a spherical linear interpolation between two Quats.
Name Type Description
b Quat The end rotation Quat.
t number interpolation amount between the two Quats.
Returns:
Type Description
Quat -

sub(q){Quat}

og/math/Quat.js, line 311
Computes the componentwise difference of two Quats.
Name Type Description
q Quat Quat to subtract.
Returns:
Type Description
Quat -

toSphericalCoords(){Object}

og/math/Quat.js, line 418
Gets spherical coordinates.
Returns:
Type Description
Object Returns object with latitude, longitude and alpha.

toVec(){Array.<number>}

og/math/Quat.js, line 344
Converts Quat values to array.
Returns:
Type Description
Array.<number> - (exactly 4 entries)