TomTomSDKRoutePlanner

Range contains reachability boundaries for one or more budgets, calculated around an origin point.

RangeBoundary represents different boundary representations. Currently it only supports polygon.

Options for range calculation.

This service calculates a set of locations that can be reached from the origin point, subject to the available fuel or energy budget that is specified in the RangeCalculationOptions.

Represents the ‘extendedRouteRepresentation’ parameter values in a Request to the Routing API.

Budget for determining maximum range which can be traveled.

Specifies options related to alternative routes.

Represents the ‘alternativeType’ parameter in a Request to the Routing API.

Specifies whether to include announcement points in instructions. Supported only in routing with extended guidance.

Road side on arrival preference for waypoints and destination.

Specifies whether to include extended sections such as road shield, lane, and speed limit sections in the route response,

Specifies options related to generated instructions. It is used by RoutePlanningOptions when planning a route.

List of errors that can be thrown during the creation of GuidanceOptions.

Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instruction.

When using any value of InstructionPhoneticsType.LHP and InstructionPhoneticsType.IPA, phonetic information (if it’s available) is returned in the Response. In this case all properties of the type TextWithPhonetics will contain the TextWithPhonetics.phoneticString value.

When using InstructionPhoneticsType.none value - no phonetic information is returned in the Response.

Examples of properties of type TextWithPhonetics: - Instruction.previousSignificantRoad.name - Instruction.nextSignificantRoad.name - Instruction.intersectionName - properties of Instruction.signpost

Represents the ‘instructionsType’ parameter in a request to the Routing API.

GuidanceVersion defines the Guidance API version to be used.

Specifies whether to include progress points (travel time and distance points) in the response.

Specifies whether to include road shield references into the external road shields atlas. If this parameter is set to all, the Instructions in route response contain RoadShield.reference that refers to the road shields of the next significant road segment after the maneuver. This refrence can then be used to decide upon the correct road shield image.

Represents types of sections of the route

A data type that contains input data for the advanceGuidanceProgress method of the RoutePlanner

RouteInformationMode defines how much guidance information (instructions and lane guidance) is returned with the route from the RoutePlanner.planRoute() function.

Options specific for concrete leg.

RoutePlanner protocol

Options for route planning.

Represents the calculated route based on a passed [RoutePlanningOptions].

A type that describes routing options with itinerary.