Quaternion helper.
- Source:
Methods
(static) add(q0, q1) → {THREE.Quaternion}
Add quaternions.
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | first quaternion |
q1 |
THREE.Quaternion | second quaternion |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) angularDistance(q0, q1) → {number}
Get rotation angle between two quaternions.
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | interval start quaternion |
q1 |
THREE.Quaternion | interval end quaternion |
- Source:
Returns:
angle in radians
- Type
- number
(static) cancelRoll(quat) → {THREE.Quaternion}
Cancel roll and return new quaternion.
Parameters:
| Name | Type | Description |
|---|---|---|
quat |
THREE.Quaternion | input quaternion |
- Source:
Returns:
quaternion without roll
- Type
- THREE.Quaternion
(static) diffBetweenQuaternions(q0, q1) → {THREE.Quaternion}
Get difference quaternion between two rotation quaternions.
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | start quaternion |
q1 |
THREE.Quaternion | end quaternion |
- Source:
Returns:
- Type
- THREE.Quaternion
(static) exp(quat) → {THREE.Quaternion}
Quaternion exp function.
Parameters:
| Name | Type | Description |
|---|---|---|
quat |
THREE.Quaternion | quaternion |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) fromEuler(yaw, pitchopt, rollopt) → {THREE.Quaternion}
Get a quaternion from euler angles.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
yaw |
TEuler | number | yaw euler angle (y axis) [radians] | |
pitch |
number |
<optional> |
pitch euler angle (x axis) [radians] |
roll |
number |
<optional> |
roll euler angle (z axis) [radians] |
- Source:
Returns:
resulting rotation quaternion
- Type
- THREE.Quaternion
(static) fromRotationMatrix(mat) → {THREE.Quaternion}
Get a quaternion from a rotation matrix.
Parameters:
| Name | Type | Description |
|---|---|---|
mat |
THREE.Matrix4 | rotation matrix |
- Source:
Returns:
quat quaternion
- Type
- THREE.Quaternion
(static) log(quat) → {THREE.Quaternion}
Quaternion log function.
Parameters:
| Name | Type | Description |
|---|---|---|
quat |
THREE.Quaternion | quaternion |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) multiplyScalar(scalar, quat) → {THREE.Quaternion}
Multiply a quaternion with a scalar.
Parameters:
| Name | Type | Description |
|---|---|---|
scalar |
number | scalar - multiplyScalar |
quat |
THREE.Quaternion | quaternion |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) nlerpNoInvert(q0, q1, t) → {THREE.Quaternion}
Compute NLERP interpolation without inversion
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | interval start quaternion |
q1 |
THREE.Quaternion | interval end quaternion |
t |
number | interpolation time |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) slerp(q0, q1, t) → {THREE.Quaternion}
Quaternion slerp computation.
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | interval start quaternion |
q1 |
THREE.Quaternion | interval end quaternion |
t |
number | interpolation time |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) slerpNoInvert(q0, q1, t) → {THREE.Quaternion}
Compute SLERP interpolation without inversion
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | interval start quaternion |
q1 |
THREE.Quaternion | interval end quaternion |
t |
number | interpolation time |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) spline(q0, q1, q2) → {THREE.Quaternion}
Make a spline from three quaternions.
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | previous quaternion |
q1 |
THREE.Quaternion | current quaternion |
q2 |
THREE.Quaternion | next quaternion |
- Source:
Returns:
- Type
- THREE.Quaternion
(static) squad(q0, a0, a1, q1, qres, t) → {THREE.Quaternion}
Compute squad interpolation.
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | interval start quaternion |
a0 |
THREE.Quaternion | left quandrangle |
a1 |
THREE.Quaternion | right quandrangle |
q1 |
THREE.Quaternion | interval end quaternion |
qres |
THREE.Quaternion | result quaternion |
t |
number | interpolation time |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) squadNoInvert(q0, a0, a1, q1, t) → {THREE.Quaternion}
Compute SQUAD interpolation without inversion
Parameters:
| Name | Type | Description |
|---|---|---|
q0 |
THREE.Quaternion | interval start quaternion |
a0 |
THREE.Quaternion | left quandrangle |
a1 |
THREE.Quaternion | right quandrangle |
q1 |
THREE.Quaternion | interval end quaternion |
t |
number | interpolation time |
- Source:
Returns:
result quaternion
- Type
- THREE.Quaternion
(static) toEuler(quat) → {TEuler}
Get euler angles from a quaternion.
Parameters:
| Name | Type | Description |
|---|---|---|
quat |
THREE.Quaternion | rotation quaternion |
- Source:
Returns:
euler angle object
- Type
- TEuler
(static) toRotationMatrix(quat) → {THREE.Matrix4}
Get a rotation matrix from a quaternion.
Parameters:
| Name | Type | Description |
|---|---|---|
quat |
THREE.Quaternion | quaternion |
- Source:
Returns:
rotation matrix
- Type
- THREE.Matrix4