Reference documentation and code samples for the Google API Common Protos Client class Quaternion.
A quaternion is defined as the quotient of two directed lines in a
three-dimensional space or equivalently as the quotient of two Euclidean
vectors (https://en.wikipedia.org/wiki/Quaternion).
Quaternions are often used in calculations involving three-dimensional
rotations (https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation),
as they provide greater mathematical robustness by avoiding the gimbal lock
problems that can be encountered when using Euler angles
(https://en.wikipedia.org/wiki/Gimbal_lock).
Quaternions are generally represented in this form:
w + xi + yj + zk
where x, y, z, and w are real numbers, and i, j, and k are three imaginary
numbers.
Our naming choice(x, y, z, w)comes from the desire to avoid confusion for
those interested in the geometric properties of the quaternion in the 3D
Cartesian space. Other texts often use alternative names or subscripts, such
as(a, b, c, d),(1, i, j, k), or(0, 1, 2, 3), which are perhaps
better suited for mathematical interpretations.
To avoid any confusion, as well as to maintain compatibility with a large
number of software libraries, the quaternions represented using the protocol
buffer belowmustfollow the Hamilton convention, which definesij = k(i.e. a right-handed algebra), and therefore:
i^2 = j^2 = k^2 = ijk = −1
ij = −ji = k
jk = −kj = i
ki = −ik = j
Please DO NOT use this to represent quaternions that follow the JPL
convention, or any of the other quaternion flavors out there.
Definitions:
Unit (or normalized) quaternion: a quaternion whose norm is 1.
Pure quaternion: a quaternion whose scalar component (w) is 0.
Rotation quaternion: a unit quaternion used to represent rotation.
Orientation quaternion: a unit quaternion used to represent orientation.
A quaternion can be normalized by dividing it by its norm. The resulting
quaternion maintains the same direction, but has a norm of 1, i.e. it moves
on the unit sphere. This is generally necessary for rotation and orientation
quaternions, to avoid rounding errors:https://en.wikipedia.org/wiki/Rotation_formalisms_in_three_dimensionsNote that(x, y, z, w)and(-x, -y, -z, -w)represent the same rotation,
but normalization would be even more useful, e.g. for comparison purposes, if
it would produce a unique representation. It is thus recommended thatwbe
kept positive, which can be achieved by changing all the signs whenwis
negative.
Generated from protobuf messagegoogle.type.Quaternion
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google API Common Protos Client - Class Quaternion (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Type.Quaternion)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Type.Quaternion)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Type.Quaternion)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Type.Quaternion)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Type.Quaternion)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Type.Quaternion) \nReference documentation and code samples for the Google API Common Protos Client class Quaternion.\n\nA quaternion is defined as the quotient of two directed lines in a\nthree-dimensional space or equivalently as the quotient of two Euclidean\nvectors (\u003chttps://en.wikipedia.org/wiki/Quaternion\u003e).\n\nQuaternions are often used in calculations involving three-dimensional\nrotations (\u003chttps://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation\u003e),\nas they provide greater mathematical robustness by avoiding the gimbal lock\nproblems that can be encountered when using Euler angles\n(\u003chttps://en.wikipedia.org/wiki/Gimbal_lock\u003e).\nQuaternions are generally represented in this form:\nw + xi + yj + zk\nwhere x, y, z, and w are real numbers, and i, j, and k are three imaginary\nnumbers.\nOur naming choice `(x, y, z, w)` comes from the desire to avoid confusion for\nthose interested in the geometric properties of the quaternion in the 3D\nCartesian space. Other texts often use alternative names or subscripts, such\nas `(a, b, c, d)`, `(1, i, j, k)`, or `(0, 1, 2, 3)`, which are perhaps\nbetter suited for mathematical interpretations.\nTo avoid any confusion, as well as to maintain compatibility with a large\nnumber of software libraries, the quaternions represented using the protocol\nbuffer below *must* follow the Hamilton convention, which defines `ij = k`\n(i.e. a right-handed algebra), and therefore:\ni\\^2 = j\\^2 = k\\^2 = ijk = −1\nij = −ji = k\njk = −kj = i\nki = −ik = j\nPlease DO NOT use this to represent quaternions that follow the JPL\nconvention, or any of the other quaternion flavors out there.\nDefinitions:\n\n- Quaternion norm (or magnitude): `sqrt(x^2 + y^2 + z^2 + w^2)`.\n- Unit (or normalized) quaternion: a quaternion whose norm is 1.\n- Pure quaternion: a quaternion whose scalar component (`w`) is 0.\n- Rotation quaternion: a unit quaternion used to represent rotation.\n- Orientation quaternion: a unit quaternion used to represent orientation. A quaternion can be normalized by dividing it by its norm. The resulting quaternion maintains the same direction, but has a norm of 1, i.e. it moves on the unit sphere. This is generally necessary for rotation and orientation quaternions, to avoid rounding errors: \u003chttps://en.wikipedia.org/wiki/Rotation_formalisms_in_three_dimensions\u003e Note that `(x, y, z, w)` and `(-x, -y, -z, -w)` represent the same rotation, but normalization would be even more useful, e.g. for comparison purposes, if it would produce a unique representation. It is thus recommended that `w` be kept positive, which can be achieved by changing all the signs when `w` is negative.\n\nGenerated from protobuf message `google.type.Quaternion`\n\nNamespace\n---------\n\nGoogle \\\\ Type\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getX\n\nThe x component.\n\n### setX\n\nThe x component.\n\n### getY\n\nThe y component.\n\n### setY\n\nThe y component.\n\n### getZ\n\nThe z component.\n\n### setZ\n\nThe z component.\n\n### getW\n\nThe scalar component.\n\n### setW\n\nThe scalar component."]]