Package com.here.sdk.core

Enum Class BodyFrame

java.lang.Object

java.lang.Enum<BodyFrame>

com.here.sdk.core.BodyFrame

All Implemented Interfaces:

Serializable, Comparable<BodyFrame>, Constable

public enum BodyFrame
extends Enum<BodyFrame>

The body frame is an object-fixed coordinate system that remains rigidly attached to the device or vehicle. All orientation values are expressed relative to this frame.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEVICE_FRAME	The device's frame, such as the frame of a smartphone, is used.
VEHICLE_FRAME	The frame of a vehicle, such as a four wheeled motor vehicle, is used.

Method Summary

Modifier and Type	Method	Description
static BodyFrame	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BodyFrame[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEVICE_FRAME

public static final BodyFrame DEVICE_FRAME

The device's frame, such as the frame of a smartphone, is used. If the device is in portrait mode so that the screen is parallel to the ground, the X (lateral) axis points toward right edge of the screen, the Y (longitudinal) axis points toward the top edge of the screen, and the Z (vertical) axis is perpendicular to the ground and points toward the sky.

VEHICLE_FRAME

public static final BodyFrame VEHICLE_FRAME

The frame of a vehicle, such as a four wheeled motor vehicle, is used. The X (longitudinal) axis points toward the front the the vehicle, the Y (lateral) axis points toward the left side of the vehicle, and the Z (vertical) axis is perpendicular to the ground and points toward the sky.

Method Details

values

public static BodyFrame[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BodyFrame valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null