Package com.here.sdk.core

Class Orientation

java.lang.Object

com.here.sdk.core.Orientation

public final class Orientation
extends Object

The orientation may originate from different sources, such as the sensors of a smartphone or an external IMU.

Field Summary

Fields

Modifier and Type	Field	Description
BodyFrame	frame	The frame that is used with the orientation.
Double	heading	Heading (degree).
Double	headingAccuracy	Estimated heading accuracy (degree).
Double	magneticDeclination	Magnetic declination (degree).
Double	pitch	Pitch (degree).
Double	pitchAccuracy	Estimated pitch accuracy (degree).
Double	roll	Roll (degree).
Double	rollAccuracy	Estimated roll accuracy (degree).
Duration	timestamp	The time instant at which the orientation was determined, relative to the device boot time (millisecond).

Constructor Summary

Constructors

Constructor	Description
Orientation(BodyFrame frame, Double heading, Double headingAccuracy, Double magneticDeclination, Double pitch, Double pitchAccuracy, Double roll, Double rollAccuracy, Duration timestamp)	Constructs a new Orientation instance using the provided parameters.
Orientation(Double heading, Double pitch, Double roll, Duration timestamp)	Constructs a new Orientation instance using the provided parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

frame

@Nullable
public BodyFrame frame

The frame that is used with the orientation. If not available, the value is null.

heading

@Nullable
public Double heading

Heading (degree). Rotation about the vertical axis or the clockwise angle between the compass direction and the true north. If available, the value is guaranteed to be in the range [0,360); North is at 0 degrees, East is at 90 degrees, South is at 180 degrees, and West is at 270 degrees. If not available, the value is null.

headingAccuracy

@Nullable
public Double headingAccuracy

Estimated heading accuracy (degree). 68th percentile of individual accuracies. If not available, the value is null.

magneticDeclination

@Nullable
public Double magneticDeclination

Magnetic declination (degree). The clockwise angle between the true north and the magnetic north. If not available, the value is null.

pitch

@Nullable
public Double pitch

Pitch (degree). Rotation about the lateral axis or the angle between the horizontal plane and the plane parallel to the ground. If available, the value is guaranteed to be in the range [-180,180]; positive value means that the horizontal plane is tilted up, negative value means that the horizontal plane is tilted down, and zero means that the planes are parallel. If not available, the value is null.

pitchAccuracy

@Nullable
public Double pitchAccuracy

Estimated pitch accuracy (degree). 68th percentile of individual accuracies. If not available, the value is null.

roll

@Nullable
public Double roll

Roll (degree). Rotation about the longitudal axis or the angle between the vertical plane and the plane perpendicular to the ground. If available, the value is guaranteed to be in the range [-180,180]; positive value means that the vertical plane is tilted to right, negative value means that the vertical plane is tilted to left, and zero means that the planes are parallel. If not available, the value is null.

rollAccuracy

@Nullable
public Double rollAccuracy

Estimated roll accuracy (degree). 68th percentile of individual accuracies. If not available, the value is null.

timestamp

@Nullable
public Duration timestamp

The time instant at which the orientation was determined, relative to the device boot time (millisecond). If not available, the value is null.

Constructor Details

Orientation

public Orientation(@Nullable
 Double heading,
 @Nullable
 Double pitch,
 @Nullable
 Double roll,
 @Nullable
 Duration timestamp)

Constructs a new Orientation instance using the provided parameters. The rest of the member variables will be initialized to null.

Parameters:

heading -

Heading (degree). Rotation about the vertical axis or the clockwise angle between the compass direction and the true north. If available, the value is guaranteed to be in the range [0,360); North is at 0 degrees, East is at 90 degrees, South is at 180 degrees, and West is at 270 degrees. If not available, the value is null.

pitch -

Pitch (degree). Rotation about the lateral axis or the angle between the horizontal plane and the plane parallel to the ground. If available, the value is guaranteed to be in the range [-180,180]; positive value means that the horizontal plane is tilted up, negative value means that the horizontal plane is tilted down, and zero means that the planes are parallel. If not available, the value is null.

roll -

Roll (degree). Rotation about the longitudal axis or the angle between the vertical plane and the plane perpendicular to the ground. If available, the value is guaranteed to be in the range [-180,180]; positive value means that the vertical plane is tilted to right, negative value means that the vertical plane is tilted to left, and zero means that the planes are parallel. If not available, the value is null.

timestamp -

The time instant at which the orientation was determined, relative to the device boot time (millisecond). If not available, the value is null.

Orientation

public Orientation(@Nullable
 BodyFrame frame,
 @Nullable
 Double heading,
 @Nullable
 Double headingAccuracy,
 @Nullable
 Double magneticDeclination,
 @Nullable
 Double pitch,
 @Nullable
 Double pitchAccuracy,
 @Nullable
 Double roll,
 @Nullable
 Double rollAccuracy,
 @Nullable
 Duration timestamp)

Constructs a new Orientation instance using the provided parameters.

Parameters:

frame -

The frame that is used with the orientation. If not available, the value is null.

heading -

Heading (degree). Rotation about the vertical axis or the clockwise angle between the compass direction and the true north. If available, the value is guaranteed to be in the range [0,360); North is at 0 degrees, East is at 90 degrees, South is at 180 degrees, and West is at 270 degrees. If not available, the value is null.

headingAccuracy -

Estimated heading accuracy (degree). 68th percentile of individual accuracies. If not available, the value is null.

magneticDeclination -

Magnetic declination (degree). The clockwise angle between the true north and the magnetic north. If not available, the value is null.

pitch -

Pitch (degree). Rotation about the lateral axis or the angle between the horizontal plane and the plane parallel to the ground. If available, the value is guaranteed to be in the range [-180,180]; positive value means that the horizontal plane is tilted up, negative value means that the horizontal plane is tilted down, and zero means that the planes are parallel. If not available, the value is null.

pitchAccuracy -

Estimated pitch accuracy (degree). 68th percentile of individual accuracies. If not available, the value is null.

roll -

Roll (degree). Rotation about the longitudal axis or the angle between the vertical plane and the plane perpendicular to the ground. If available, the value is guaranteed to be in the range [-180,180]; positive value means that the vertical plane is tilted to right, negative value means that the vertical plane is tilted to left, and zero means that the planes are parallel. If not available, the value is null.

rollAccuracy -

Estimated roll accuracy (degree). 68th percentile of individual accuracies. If not available, the value is null.

timestamp -

The time instant at which the orientation was determined, relative to the device boot time (millisecond). If not available, the value is null.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object