maplibre-navigation-core/org.maplibre.navigation.core.models/StepManeuver

StepManeuver

@Serializable

data class StepManeuver(val location: Point, val bearingBefore: Double, val bearingAfter: Double, val instruction: String? = null, val type: StepManeuver.Type? = null, val modifier: ManeuverModifier.Type? = null, val exit: Int? = null)

Gives maneuver information about one LegStep.

Since

1.0.0

Constructors

StepManeuver

constructor(location: Point, bearingBefore: Double, bearingAfter: Double, instruction: String? = null, type: StepManeuver.Type? = null, modifier: ManeuverModifier.Type? = null, exit: Int? = null)

Types

Builder

class Builder(location: Point, bearingBefore: Double, bearingAfter: Double)

Builder class for creating StepManeuver instances.

Type

@Serializable

enum Type : Enum<StepManeuver.Type>

Properties

bearingAfter

@SerialName(value = "bearing_after")

val bearingAfter: Double

Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right after the maneuver.

bearingBefore

@SerialName(value = "bearing_before")

val bearingBefore: Double

Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right before the maneuver.

exit

val exit: Int? = null

An optional integer indicating number of the exit to take. If exit is undefined the destination is on the roundabout. The property exists for the following type properties:

instruction

val instruction: String? = null

A human-readable instruction of how to execute the returned maneuver. This String is built using OSRM-Text-Instructions and can be further customized inside either the Mapbox Navigation SDK for Android or using the OSRM-Text-Instructions.java project in Project-OSRM.

location

@Serializable(with = PointSerializer::class)

val location: Point

A Point representing this intersection location.

modifier

val modifier: ManeuverModifier.Type? = null

This indicates the mode of the maneuver. If type is of turn, the modifier indicates the change in direction accomplished through the turn. If the type is of depart/arrive, the modifier indicates the position of waypoint from the current direction of travel.

type

val type: StepManeuver.Type? = null

This indicates the type of maneuver.

Functions

toBuilder

fun toBuilder(): StepManeuver.Builder

Creates a builder initialized with the current values of the StepManeuver instance.