Package com.google.type
Class Quaternion.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
- com.google.type.Quaternion.Builder
-
- All Implemented Interfaces:
com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,QuaternionOrBuilder
,java.lang.Cloneable
- Enclosing class:
- Quaternion
public static final class Quaternion.Builder extends com.google.protobuf.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 that `w` be kept positive, which can be achieved by changing all the signs when `w` is negative.
Protobuf typegoogle.type.Quaternion
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Quaternion.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Quaternion
build()
Quaternion
buildPartial()
Quaternion.Builder
clear()
Quaternion.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Quaternion.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Quaternion.Builder
clearW()
The scalar component.Quaternion.Builder
clearX()
The x component.Quaternion.Builder
clearY()
The y component.Quaternion.Builder
clearZ()
The z component.Quaternion.Builder
clone()
Quaternion
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
double
getW()
The scalar component.double
getX()
The x component.double
getY()
The y component.double
getZ()
The z component.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
Quaternion.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Quaternion.Builder
mergeFrom(com.google.protobuf.Message other)
Quaternion.Builder
mergeFrom(Quaternion other)
Quaternion.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Quaternion.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Quaternion.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Quaternion.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Quaternion.Builder
setW(double value)
The scalar component.Quaternion.Builder
setX(double value)
The x component.Quaternion.Builder
setY(double value)
The y component.Quaternion.Builder
setZ(double value)
The z component.-
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder
addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension
-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
clear
public Quaternion.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<Quaternion.Builder>
-
getDefaultInstanceForType
public Quaternion getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public Quaternion build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public Quaternion buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public Quaternion.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
setField
public Quaternion.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
clearField
public Quaternion.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
clearOneof
public Quaternion.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
setRepeatedField
public Quaternion.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
addRepeatedField
public Quaternion.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
mergeFrom
public Quaternion.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Quaternion.Builder>
-
mergeFrom
public Quaternion.Builder mergeFrom(Quaternion other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,Quaternion.Builder>
-
mergeFrom
public Quaternion.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Quaternion.Builder>
- Throws:
java.io.IOException
-
getX
public double getX()
The x component.
double x = 1;
- Specified by:
getX
in interfaceQuaternionOrBuilder
- Returns:
- The x.
-
setX
public Quaternion.Builder setX(double value)
The x component.
double x = 1;
- Parameters:
value
- The x to set.- Returns:
- This builder for chaining.
-
clearX
public Quaternion.Builder clearX()
The x component.
double x = 1;
- Returns:
- This builder for chaining.
-
getY
public double getY()
The y component.
double y = 2;
- Specified by:
getY
in interfaceQuaternionOrBuilder
- Returns:
- The y.
-
setY
public Quaternion.Builder setY(double value)
The y component.
double y = 2;
- Parameters:
value
- The y to set.- Returns:
- This builder for chaining.
-
clearY
public Quaternion.Builder clearY()
The y component.
double y = 2;
- Returns:
- This builder for chaining.
-
getZ
public double getZ()
The z component.
double z = 3;
- Specified by:
getZ
in interfaceQuaternionOrBuilder
- Returns:
- The z.
-
setZ
public Quaternion.Builder setZ(double value)
The z component.
double z = 3;
- Parameters:
value
- The z to set.- Returns:
- This builder for chaining.
-
clearZ
public Quaternion.Builder clearZ()
The z component.
double z = 3;
- Returns:
- This builder for chaining.
-
getW
public double getW()
The scalar component.
double w = 4;
- Specified by:
getW
in interfaceQuaternionOrBuilder
- Returns:
- The w.
-
setW
public Quaternion.Builder setW(double value)
The scalar component.
double w = 4;
- Parameters:
value
- The w to set.- Returns:
- This builder for chaining.
-
clearW
public Quaternion.Builder clearW()
The scalar component.
double w = 4;
- Returns:
- This builder for chaining.
-
setUnknownFields
public final Quaternion.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
mergeUnknownFields
public final Quaternion.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
-
-