WemapCoreSDK/com.getwemap.sdk.core.model.entities/Step

Step

@Serializable

data class Step

A single step of a navigation leg.

Types

Direction

enum Direction : Enum<Step.Direction>

The direction of a navigation Step, such as a turn or a vertical movement.

Kind

@Serializable(with = Step.Kind.Serializer::class)

sealed class Kind

The kind of a navigation Step, such as a turn, an elevator, or stairs.

Properties

angle

val angle: Double

in radians

coordinate

@Serializable(with = CompressedCoordinateSerializer::class)

@SerialName(value = "coords")

val coordinate: Coordinate

The coordinate of the step.

destinationLevel

val destinationLevel: Float?

The level reached at the destination of this step, if any.

direction

val direction: Step.Direction?

The direction of the step, if any.

distance

val distance: Double

in meters

duration

val duration: Double

in seconds

isFirstStep

@SerialName(value = "firstStep")

val isFirstStep: Boolean

Indicates whether this is the first step of the itinerary.

isImportant

@SerialName(value = "important")

val isImportant: Boolean

Indicates whether this step is important for the navigation.

isLastStep

@SerialName(value = "lastStep")

val isLastStep: Boolean

Indicates whether this is the last step of the itinerary.

kind

@SerialName(value = "type")

val kind: Step.Kind?

The kind of the step, if any.

levelDifference

val levelDifference: Float?

The difference in levels between this step and the next one, if any.

name

val name: String?

The name of the step, typically the street or place name.

nextBearing

val nextBearing: Double

in radians

number

val number: Int

The index of the step within its leg.

previousBearing

val previousBearing: Double

in radians

Functions

getNavigationInstructions

fun getNavigationInstructions(context: Context, includeStreetNames: Boolean = true): NavigationInstructions

Provides localized navigation instructions for this step