public static final class Quaternion.Builder extends GeneratedMessageV3.Builder<Quaternion.Builder> implements QuaternionOrBuilder 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 below must follow the Hamilton convention, which defines ij = 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:
- Quaternion norm (or magnitude):
sqrt(x^2 + y^2 + z^2 + w^2). - 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_dimensions
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 thatwbe kept positive, which can be achieved by changing all the signs whenwis negative.
Protobuf type google.type.Quaternion
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Quaternion.BuilderImplements
QuaternionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Quaternion.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field | FieldDescriptor |
value | Object |
| Type | Description |
Quaternion.Builder |
build()
public Quaternion build()| Type | Description |
Quaternion |
buildPartial()
public Quaternion buildPartial()| Type | Description |
Quaternion |
clear()
public Quaternion.Builder clear()| Type | Description |
Quaternion.Builder |
clearField(Descriptors.FieldDescriptor field)
public Quaternion.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
field | FieldDescriptor |
| Type | Description |
Quaternion.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public Quaternion.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
oneof | OneofDescriptor |
| Type | Description |
Quaternion.Builder |
clearW()
public Quaternion.Builder clearW()The scalar component.
double w = 4;
| Type | Description |
Quaternion.Builder | This builder for chaining. |
clearX()
public Quaternion.Builder clearX()The x component.
double x = 1;
| Type | Description |
Quaternion.Builder | This builder for chaining. |
clearY()
public Quaternion.Builder clearY()The y component.
double y = 2;
| Type | Description |
Quaternion.Builder | This builder for chaining. |
clearZ()
public Quaternion.Builder clearZ()The z component.
double z = 3;
| Type | Description |
Quaternion.Builder | This builder for chaining. |
clone()
public Quaternion.Builder clone()| Type | Description |
Quaternion.Builder |
getDefaultInstanceForType()
public Quaternion getDefaultInstanceForType()| Type | Description |
Quaternion |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
Descriptor |
getW()
public double getW()The scalar component.
double w = 4;
| Type | Description |
double | The w. |
getX()
public double getX()The x component.
double x = 1;
| Type | Description |
double | The x. |
getY()
public double getY()The y component.
double y = 2;
| Type | Description |
double | The y. |
getZ()
public double getZ()The z component.
double z = 3;
| Type | Description |
double | The z. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Quaternion.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
Quaternion.Builder |
| Type | Description |
IOException |
mergeFrom(Message other)
public Quaternion.Builder mergeFrom(Message other)| Name | Description |
other | Message |
| Type | Description |
Quaternion.Builder |
mergeFrom(Quaternion other)
public Quaternion.Builder mergeFrom(Quaternion other)| Name | Description |
other | Quaternion |
| Type | Description |
Quaternion.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Quaternion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
unknownFields | UnknownFieldSet |
| Type | Description |
Quaternion.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Quaternion.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field | FieldDescriptor |
value | Object |
| Type | Description |
Quaternion.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Quaternion.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Type | Description |
Quaternion.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Quaternion.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
unknownFields | UnknownFieldSet |
| Type | Description |
Quaternion.Builder |
setW(double value)
public Quaternion.Builder setW(double value)The scalar component.
double w = 4;
| Name | Description |
value | doubleThe w to set. |
| Type | Description |
Quaternion.Builder | This builder for chaining. |
setX(double value)
public Quaternion.Builder setX(double value)The x component.
double x = 1;
| Name | Description |
value | doubleThe x to set. |
| Type | Description |
Quaternion.Builder | This builder for chaining. |
setY(double value)
public Quaternion.Builder setY(double value)The y component.
double y = 2;
| Name | Description |
value | doubleThe y to set. |
| Type | Description |
Quaternion.Builder | This builder for chaining. |
setZ(double value)
public Quaternion.Builder setZ(double value)The z component.
double z = 3;
| Name | Description |
value | doubleThe z to set. |
| Type | Description |
Quaternion.Builder | This builder for chaining. |