LaneDirection

@CarProtocol
class LaneDirection


Defines the possible directions a driver can go when using a particular lane at a particular step in the navigation.

These directions can be combined and sent to the host to display a lane configuration to the user.

See also
Lane

Summary

Constants

const Int

Regular left turn, from 45 (included) to 135 (excluded) degrees.

const Int

Regular right turn, from 45 (included) to 135 (excluded) degrees.

const Int

Sharp left turn, from 135 (included) to 175 (excluded) degrees.

const Int

Sharp right turn, from 135 (included) to 175 (excluded) degrees.

const Int

Slight left turn, from 10 (included) to 45 (excluded) degrees.

const Int

Slight right turn, from 10 (included) to 45 (excluded) degrees.

const Int

No turn.

const Int

The shape is unknown, in which case no lane information should be shown.

const Int

A left turn onto the opposite side of the same street, from 175 (included) to 180 (included) degrees

const Int

A right turn onto the opposite side of the same street, from 175 (included) to 180 (included) degrees

Public functions

java-static LaneDirection
create(shape: Int, isRecommended: Boolean)

Constructs a new instance of a LaneDirection.

Boolean
equals(other: Any?)
Int

Returns shape of this lane direction.

Int
Boolean

Returns whether this is a direction the driver should take in order to stay on the navigation route.

String

Constants

SHAPE_NORMAL_LEFT

Added in 1.0.0
const val SHAPE_NORMAL_LEFT = 5: Int

Regular left turn, from 45 (included) to 135 (excluded) degrees.

SHAPE_NORMAL_RIGHT

Added in 1.0.0
const val SHAPE_NORMAL_RIGHT = 6: Int

Regular right turn, from 45 (included) to 135 (excluded) degrees.

SHAPE_SHARP_LEFT

Added in 1.0.0
const val SHAPE_SHARP_LEFT = 7: Int

Sharp left turn, from 135 (included) to 175 (excluded) degrees.

SHAPE_SHARP_RIGHT

Added in 1.0.0
const val SHAPE_SHARP_RIGHT = 8: Int

Sharp right turn, from 135 (included) to 175 (excluded) degrees.

SHAPE_SLIGHT_LEFT

Added in 1.0.0
const val SHAPE_SLIGHT_LEFT = 3: Int

Slight left turn, from 10 (included) to 45 (excluded) degrees.

SHAPE_SLIGHT_RIGHT

Added in 1.0.0
const val SHAPE_SLIGHT_RIGHT = 4: Int

Slight right turn, from 10 (included) to 45 (excluded) degrees.

SHAPE_STRAIGHT

Added in 1.0.0
const val SHAPE_STRAIGHT = 2: Int

No turn.

SHAPE_UNKNOWN

Added in 1.0.0
const val SHAPE_UNKNOWN = 1: Int

The shape is unknown, in which case no lane information should be shown.

SHAPE_U_TURN_LEFT

Added in 1.0.0
const val SHAPE_U_TURN_LEFT = 9: Int

A left turn onto the opposite side of the same street, from 175 (included) to 180 (included) degrees

SHAPE_U_TURN_RIGHT

Added in 1.0.0
const val SHAPE_U_TURN_RIGHT = 10: Int

A right turn onto the opposite side of the same street, from 175 (included) to 180 (included) degrees

Public functions

create

Added in 1.0.0
java-static fun create(shape: Int, isRecommended: Boolean): LaneDirection

Constructs a new instance of a LaneDirection.

Parameters
shape: Int

one of the SHAPE_* static constants defined in this class

isRecommended: Boolean

indicates whether the LaneDirection is the one the driver should take in order to stay on the navigation route

equals

Added in 1.4.0-rc02
fun equals(other: Any?): Boolean

getShape

Added in 1.0.0
fun getShape(): Int

Returns shape of this lane direction.

hashCode

Added in 1.4.0-rc02
fun hashCode(): Int

isRecommended

Added in 1.0.0
fun isRecommended(): Boolean

Returns whether this is a direction the driver should take in order to stay on the navigation route.

toString

Added in 1.4.0-rc02
fun toString(): String