maplibre-navigation-core/org.maplibre.navigation.core.models/LegStep/Builder

Builder

class Builder(geometry: String, distance: Double, duration: Double, maneuver: StepManeuver)

Builder class for creating LegStep instances.

Parameters

geometry

Gives the geometry of the leg step as encoded polyline string.

distance

The distance traveled from the maneuver to the next LegStep in meters.

duration

The estimated travel time from the maneuver to the next LegStep in seconds.

mode

Indicates the mode of transportation in the step.

maneuver

A StepManeuver object that typically represents the first coordinate making up the LegStep.geometry.

weight

Specifies a decimal precision of edge weights, default value 1.

Constructors

Link copied to clipboard
constructor(geometry: String, distance: Double, duration: Double, maneuver: StepManeuver)

Functions

Link copied to clipboard
fun build(): LegStep

Builds a LegStep instance with the current builder values.

Link copied to clipboard
fun withBannerInstructions(bannerInstructions: List<BannerInstructions>?): LegStep.Builder

Sets the banner instructions.

Link copied to clipboard
fun withDestinations(destinations: String?): LegStep.Builder

Sets the destinations.

Link copied to clipboard
fun withDrivingSide(drivingSide: String?): LegStep.Builder

Sets the driving side.

Link copied to clipboard
fun withDurationTypical(durationTypical: Double?): LegStep.Builder

Sets the typical duration.

Link copied to clipboard
fun withExits(exits: String?): LegStep.Builder

Sets the exits.

Link copied to clipboard
fun withIntersections(intersections: List<StepIntersection>?): LegStep.Builder

Sets the intersections.

Link copied to clipboard
fun withMode(mode: String): LegStep.Builder

Set the mode of transportation in the step. Default value is driving.

Link copied to clipboard
fun withName(name: String?): LegStep.Builder

Sets the name.

Link copied to clipboard
fun withPronunciation(pronunciation: String?): LegStep.Builder

Sets the pronunciation.

Link copied to clipboard
fun withRef(ref: String?): LegStep.Builder

Sets the reference.

Link copied to clipboard
fun withRotaryName(rotaryName: String?): LegStep.Builder

Sets the rotary name.

Link copied to clipboard
fun withRotaryPronunciation(rotaryPronunciation: String?): LegStep.Builder

Sets the rotary pronunciation.

Link copied to clipboard
fun withSpeedLimitSign(speedLimitSign: LegStep.SpeedLimitSign?): LegStep.Builder

Sets the speed limit sign.

Link copied to clipboard
fun withSpeedLimitUnit(speedLimitUnit: SpeedLimit.Unit?): LegStep.Builder

Sets the speed limit unit.

Link copied to clipboard
fun withVoiceInstructions(voiceInstructions: List<VoiceInstructions>?): LegStep.Builder

Sets the voice instructions.

Link copied to clipboard
fun withWeight(weight: Double): LegStep.Builder

Set a decimal precision of edge weights. Default value is 1.