REVO / API version 0.0.10
Quaternion
Immutable quaternion. Constructor arguments are not normalized.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Quaternion():
Quaternion
Creates the identity quaternion (0, 0, 0, 1).
Returns
Section titled “Returns”Quaternion
Constructor
Section titled “Constructor”new Quaternion(
x,y,z,w):Quaternion
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
x |
number |
- |
y |
number |
- |
z |
number |
- |
w |
number |
Scalar component. |
Returns
Section titled “Returns”Quaternion
Constructor
Section titled “Constructor”new Quaternion(
value):Quaternion
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
[number, number, number, number] |
Returns
Section titled “Returns”Quaternion
Constructor
Section titled “Constructor”new Quaternion(
value):Quaternion
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IQuaternion |
Returns
Section titled “Returns”Quaternion
Constructor
Section titled “Constructor”new Quaternion(
value):Quaternion
Sets every component to value.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
number |
Returns
Section titled “Returns”Quaternion
Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
length |
number |
— |
lengthSquared |
number |
— |
w |
number |
|
x |
number |
|
y |
number |
|
z |
number |
|
one |
Quaternion |
— |
zero |
Quaternion |
— |
Methods
Section titled “Methods”equals()
Section titled “equals()”equals(
value,epsilon?):boolean
Compares components: q and -q are unequal despite representing the same rotation.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value |
IQuaternion |
- |
epsilon? |
number |
Finite, non-negative tolerance per component. Defaults to 0. |
Returns
Section titled “Returns”boolean
inverse()
Section titled “inverse()”inverse():
Quaternion
Returns the inverse. Throws RangeError for a zero or infinite quaternion, or if the result overflows.
Returns
Section titled “Returns”Quaternion
mul(
value):Quaternion
Hamilton product: this quaternion multiplied by value.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IQuaternion |
Returns
Section titled “Returns”Quaternion
normalize()
Section titled “normalize()”normalize():
Quaternion
Throws RangeError for a zero or infinite quaternion.
Returns
Section titled “Returns”Quaternion
rotate()
Section titled “rotate()”rotate(
value):Vector3
Rotates a vector. This quaternion must have unit length.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector3 |
Returns
Section titled “Returns”toArray()
Section titled “toArray()”toArray(): [
number,number,number,number]
Returns [x, y, z, w].
Returns
Section titled “Returns”[number, number, number, number]
toFixed()
Section titled “toFixed()”toFixed(
precision?):Quaternion
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
precision? |
number |
Number of decimal places. Must be an integer from 0 to 100. Defaults to 4. |
Returns
Section titled “Returns”Quaternion
toString()
Section titled “toString()”toString():
string
Returns a string representation of an object.
Returns
Section titled “Returns”string