org.cesiumjs.cs.core

Class HeadingPitchRoll

java.lang.Object

org.cesiumjs.cs.core.HeadingPitchRoll

@JsType(isNative=true,
        namespace="Cesium",
        name="HeadingPitchRoll")
public class HeadingPitchRoll
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	heading
double	pitch
double	roll

Constructor Summary

Constructors

Constructor and Description
HeadingPitchRoll() A rotation expressed as a heading, pitch, and roll.
HeadingPitchRoll(double heading, double pitch) A rotation expressed as a heading, pitch, and roll.
HeadingPitchRoll(double heading, double pitch, double roll) A rotation expressed as a heading, pitch, and roll.

Method Summary

Modifier and Type	Method and Description
HeadingPitchRoll	clone() The object onto which to store the result.
static HeadingPitchRoll	clone(HeadingPitchRoll headingPitchRoll) Duplicates a HeadingPitchRoll instance.
static HeadingPitchRoll	clone(HeadingPitchRoll headingPitchRoll, HeadingPitchRoll result) Duplicates a HeadingPitchRoll instance.
boolean	equals(HeadingPitchRoll right) Compares this HeadingPitchRoll against the provided HeadingPitchRoll componentwise and returns true if they are equal, false otherwise.
static boolean	equals(HeadingPitchRoll left, HeadingPitchRoll right) Compares the provided HeadingPitchRolls componentwise and returns true if they are equal, false otherwise.
boolean	equalsEpsilon(HeadingPitchRoll right, double relativeEpsilon, double absoluteEpsilon) Compares this HeadingPitchRoll against the provided HeadingPitchRoll componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
static boolean	equalsEpsilon(HeadingPitchRoll left, HeadingPitchRoll right, double relativeEpsilon, double absoluteEpsilon) Compares the provided HeadingPitchRolls componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
static HeadingPitchRoll	fromDegrees(double heading, double pitch, double roll) Returns a new HeadingPitchRoll instance from angles given in degrees.
static HeadingPitchRoll	fromDegrees(double heading, double pitch, double roll, HeadingPitchRoll result) Returns a new HeadingPitchRoll instance from angles given in degrees.
static HeadingPitchRoll	fromQuaternion(Quaternion quaternion) Computes the heading, pitch and roll from a quaternion (see http://en.wikipedia.org/wiki/Conversion_between_quaternions_and_Euler_angles )
static HeadingPitchRoll	fromQuaternion(Quaternion quaternion, Quaternion result) Computes the heading, pitch and roll from a quaternion (see http://en.wikipedia.org/wiki/Conversion_between_quaternions_and_Euler_angles )
String	toString() Creates a string representing this HeadingPitchRoll in the format '(heading, pitch, roll)' in radians.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

heading

@JsProperty
public double heading

pitch

@JsProperty
public double pitch

roll

@JsProperty
public double roll

Constructor Detail

HeadingPitchRoll

@JsConstructor
public HeadingPitchRoll()

A rotation expressed as a heading, pitch, and roll. Heading is the rotation about the negative z axis. Pitch is the rotation about the negative y axis. Roll is the rotation about the positive x axis.

HeadingPitchRoll

@JsConstructor
public HeadingPitchRoll(double heading,
                                       double pitch)

A rotation expressed as a heading, pitch, and roll. Heading is the rotation about the negative z axis. Pitch is the rotation about the negative y axis. Roll is the rotation about the positive x axis.

Parameters:

heading - The heading component in radians. Default: 0.0

pitch - The pitch component in radians. Default: 0.0

HeadingPitchRoll

@JsConstructor
public HeadingPitchRoll(double heading,
                                       double pitch,
                                       double roll)

A rotation expressed as a heading, pitch, and roll. Heading is the rotation about the negative z axis. Pitch is the rotation about the negative y axis. Roll is the rotation about the positive x axis.

Parameters:

heading - The heading component in radians. Default: 0.0

pitch - The pitch component in radians. Default: 0.0

roll - The roll component in radians. Default: 0.0

Method Detail

clone

@JsMethod
public static HeadingPitchRoll clone(HeadingPitchRoll headingPitchRoll)

Duplicates a HeadingPitchRoll instance.

Parameters:

headingPitchRoll - The HeadingPitchRoll to duplicate.

Returns:

The modified result parameter or a new HeadingPitchRoll instance if one was not provided. (Returns undefined if headingPitchRoll is undefined)

clone

@JsMethod
public static HeadingPitchRoll clone(HeadingPitchRoll headingPitchRoll,
                                               HeadingPitchRoll result)

Duplicates a HeadingPitchRoll instance.

Parameters:

headingPitchRoll - The HeadingPitchRoll to duplicate.

result - The object onto which to store the result.

Returns:

The modified result parameter or a new HeadingPitchRoll instance if one was not provided. (Returns undefined if headingPitchRoll is undefined)

equals

@JsMethod
public static boolean equals(HeadingPitchRoll left,
                                       HeadingPitchRoll right)

Compares the provided HeadingPitchRolls componentwise and returns true if they are equal, false otherwise.

Parameters:

left - The first HeadingPitchRoll.

right - The second HeadingPitchRoll.

Returns:

true if left and right are equal, false otherwise.

equalsEpsilon

@JsMethod
public static boolean equalsEpsilon(HeadingPitchRoll left,
                                              HeadingPitchRoll right,
                                              double relativeEpsilon,
                                              double absoluteEpsilon)

Compares the provided HeadingPitchRolls componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

Parameters:

left - The first HeadingPitchRoll.

right - The second HeadingPitchRoll.

relativeEpsilon - The relative epsilon tolerance to use for equality testing.

absoluteEpsilon - The absolute epsilon tolerance to use for equality testing.

Returns:

true if left and right are within the provided epsilon, false otherwise.

fromDegrees

@JsMethod
public static HeadingPitchRoll fromDegrees(double heading,
                                                     double pitch,
                                                     double roll)

Returns a new HeadingPitchRoll instance from angles given in degrees.

Parameters:

heading - the heading in degrees

pitch - the pitch in degrees

roll - the heading in degrees

Returns:

A new HeadingPitchRoll instance

fromDegrees

@JsMethod
public static HeadingPitchRoll fromDegrees(double heading,
                                                     double pitch,
                                                     double roll,
                                                     HeadingPitchRoll result)

Returns a new HeadingPitchRoll instance from angles given in degrees.

Parameters:

heading - the heading in degrees

pitch - the pitch in degrees

roll - the heading in degrees

result - The object in which to store the result. If not provided, a new instance is created and returned.

Returns:

A new HeadingPitchRoll instance

fromQuaternion

@JsMethod
public static HeadingPitchRoll fromQuaternion(Quaternion quaternion)

Computes the heading, pitch and roll from a quaternion (see http://en.wikipedia.org/wiki/Conversion_between_quaternions_and_Euler_angles )

Parameters:

quaternion - The quaternion from which to retrieve heading, pitch, and roll, all expressed in radians.

Returns:

The modified result parameter or a new HeadingPitchRoll instance if one was not provided.

fromQuaternion

@JsMethod
public static HeadingPitchRoll fromQuaternion(Quaternion quaternion,
                                                        Quaternion result)

Computes the heading, pitch and roll from a quaternion (see http://en.wikipedia.org/wiki/Conversion_between_quaternions_and_Euler_angles )

Parameters:

quaternion - The quaternion from which to retrieve heading, pitch, and roll, all expressed in radians.

result - The object in which to store the result. If not provided, a new instance is created and returned.

Returns:

The modified result parameter or a new HeadingPitchRoll instance if one was not provided.

clone

@JsMethod
public HeadingPitchRoll clone()

The object onto which to store the result.

Overrides:

clone in class Object

Returns:

The modified result parameter or a new HeadingPitchRoll instance if one was not provided.

equals

@JsMethod
public boolean equals(HeadingPitchRoll right)

Compares this HeadingPitchRoll against the provided HeadingPitchRoll componentwise and returns true if they are equal, false otherwise.

Parameters:

right - The right hand side HeadingPitchRoll.

Returns:

true if they are equal, false otherwise.

equalsEpsilon

@JsMethod
public boolean equalsEpsilon(HeadingPitchRoll right,
                                       double relativeEpsilon,
                                       double absoluteEpsilon)

Compares this HeadingPitchRoll against the provided HeadingPitchRoll componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

Parameters:

right - The right hand side HeadingPitchRoll.

relativeEpsilon - The relative epsilon tolerance to use for equality testing.

absoluteEpsilon - The absolute epsilon tolerance to use for equality testing.

Returns:

true if they are within the provided epsilon, false otherwise.

toString

@JsMethod
public String toString()

Creates a string representing this HeadingPitchRoll in the format '(heading, pitch, roll)' in radians.

Overrides:

toString in class Object

Returns:

A string representing the provided HeadingPitchRoll in the format '(heading, pitch, roll)'.