Quaternion.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Quaternion.Builder>
    - - com.google.type.Quaternion.Builder

All Implemented Interfaces:: Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, QuaternionOrBuilder, java.lang.Cloneable

Enclosing class:: Quaternion

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 that w be kept
 positive, which can be achieved by changing all the signs when w is negative.
 Next available tag: 5

Protobuf type google.type.Quaternion

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Quaternion.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`Quaternion`	`build()`
`Quaternion`	`buildPartial()`
`Quaternion.Builder`	`clear()`
`Quaternion.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`Quaternion.Builder`	`clearOneof(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 Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`double`	`getW()` The scalar component.
`double`	`getX()` The x component.
`double`	`getY()` The y component.
`double`	`getZ()` The z component.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Quaternion.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`Quaternion.Builder`	`mergeFrom(Message other)`
`Quaternion.Builder`	`mergeFrom(Quaternion other)`
`Quaternion.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`Quaternion.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`Quaternion.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`Quaternion.Builder`	`setUnknownFields(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.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - clear
```
public Quaternion.Builder clear()
```
    Specified by:
    
    clear in interface Message.Builder
    
    Specified by:
    
    clear in interface MessageLite.Builder
    
    Overrides:
    
    clear in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - getDefaultInstanceForType
```
public Quaternion getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder
  - build
```
public Quaternion build()
```
    Specified by:
    
    build in interface Message.Builder
    
    Specified by:
    
    build in interface MessageLite.Builder
  - buildPartial
```
public Quaternion buildPartial()
```
    Specified by:
    
    buildPartial in interface Message.Builder
    
    Specified by:
    
    buildPartial in interface MessageLite.Builder
  - clone
```
public Quaternion.Builder clone()
```
    Specified by:
    
    clone in interface Message.Builder
    
    Specified by:
    
    clone in interface MessageLite.Builder
    
    Overrides:
    
    clone in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - setField
```
public Quaternion.Builder setField(Descriptors.FieldDescriptor field,
                                   java.lang.Object value)
```
    Specified by:
    
    setField in interface Message.Builder
    
    Overrides:
    
    setField in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - clearField
```
public Quaternion.Builder clearField(Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface Message.Builder
    
    Overrides:
    
    clearField in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - clearOneof
```
public Quaternion.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface Message.Builder
    
    Overrides:
    
    clearOneof in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - setRepeatedField
```
public Quaternion.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                           int index,
                                           java.lang.Object value)
```
    Specified by:
    
    setRepeatedField in interface Message.Builder
    
    Overrides:
    
    setRepeatedField in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - addRepeatedField
```
public Quaternion.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                           java.lang.Object value)
```
    Specified by:
    
    addRepeatedField in interface Message.Builder
    
    Overrides:
    
    addRepeatedField in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - mergeFrom
```
public Quaternion.Builder mergeFrom(Message other)
```
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Quaternion.Builder>
  - mergeFrom
```
public Quaternion.Builder mergeFrom(Quaternion other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - mergeFrom
```
public Quaternion.Builder mergeFrom(CodedInputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Specified by:
    
    mergeFrom in interface MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Quaternion.Builder>
    
    Throws:
    
    java.io.IOException
  - getX
```
public double getX()
```
```
 The x component.
 
```
    double x = 1;
    Specified by:
    
    getX in interface QuaternionOrBuilder
  - setX
```
public Quaternion.Builder setX(double value)
```
```
 The x component.
 
```
    double x = 1;
  - clearX
```
public Quaternion.Builder clearX()
```
```
 The x component.
 
```
    double x = 1;
  - getY
```
public double getY()
```
```
 The y component.
 
```
    double y = 2;
    Specified by:
    
    getY in interface QuaternionOrBuilder
  - setY
```
public Quaternion.Builder setY(double value)
```
```
 The y component.
 
```
    double y = 2;
  - clearY
```
public Quaternion.Builder clearY()
```
```
 The y component.
 
```
    double y = 2;
  - getZ
```
public double getZ()
```
```
 The z component.
 
```
    double z = 3;
    Specified by:
    
    getZ in interface QuaternionOrBuilder
  - setZ
```
public Quaternion.Builder setZ(double value)
```
```
 The z component.
 
```
    double z = 3;
  - clearZ
```
public Quaternion.Builder clearZ()
```
```
 The z component.
 
```
    double z = 3;
  - getW
```
public double getW()
```
```
 The scalar component.
 
```
    double w = 4;
    Specified by:
    
    getW in interface QuaternionOrBuilder
  - setW
```
public Quaternion.Builder setW(double value)
```
```
 The scalar component.
 
```
    double w = 4;
  - clearW
```
public Quaternion.Builder clearW()
```
```
 The scalar component.
 
```
    double w = 4;
  - setUnknownFields
```
public final Quaternion.Builder setUnknownFields(UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface Message.Builder
    
    Overrides:
    
    setUnknownFields in class GeneratedMessageV3.Builder<Quaternion.Builder>
  - mergeUnknownFields
```
public final Quaternion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class GeneratedMessageV3.Builder<Quaternion.Builder>

Class Quaternion.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getX

setX

clearX

getY

setY

clearY

getZ

setZ

clearZ

getW

setW

clearW

setUnknownFields

mergeUnknownFields