SKRouteSettings Class Reference

Inherits from NSObject
Declared in SKRouteSettings.h

Overview

The SKRouteSettings stores settings about a route. Used as input for a route calculation.

  startCoordinate

The start coordinate of the route.

@property (nonatomic, assign) CLLocationCoordinate2D startCoordinate

Discussion

The start coordinate of the route.

Declared In

SKRouteSettings.h

  destinationCoordinate

The destination coordinate of the route.

@property (nonatomic, assign) CLLocationCoordinate2D destinationCoordinate

Discussion

The destination coordinate of the route.

Declared In

SKRouteSettings.h

  viaPoints

Via Points along the route. An array of SKViaPoint objects.

@property (nonatomic, strong) NSArray<SKViaPoint*> *viaPoints

Discussion

Via Points along the route. An array of SKViaPoint objects.

Declared In

SKRouteSettings.h

  routeMode

The route calculation mode. The default is SKRouteCarEfficient.

@property (nonatomic, assign) SKRouteMode routeMode

Discussion

The route calculation mode. The default is SKRouteCarEfficient.

Declared In

SKRouteSettings.h

  routeConnectionMode

The route calculation connectivity mode. The default value is SKRouteConnectionHybrid.

@property (nonatomic, assign) SKRouteConnectionMode routeConnectionMode

Discussion

The route calculation connectivity mode. The default value is SKRouteConnectionHybrid.

Declared In

SKRouteSettings.h

  shouldBeRendered

Indicates whether the route should be rendered on the map.

@property (nonatomic, assign) BOOL shouldBeRendered

Discussion

Indicates whether the route should be rendered on the map.

Declared In

SKRouteSettings.h

  routeRestrictions

Indicates whether to avoid toll roads, highways (Motorways & Motorway links), ferry lines, roads that make the user walk along his bike or carry his bike when calculating the route.

@property (nonatomic, assign) SKRouteRestrictions routeRestrictions

Discussion

Indicates whether to avoid toll roads, highways (Motorways & Motorway links), ferry lines, roads that make the user walk along his bike or carry his bike when calculating the route.

Declared In

SKRouteSettings.h

  requestCountryCodes

If set to YES, routeCountriesForRouteWithId: will return valid country codes after calculation. Default is NO.

@property (nonatomic, assign) BOOL requestCountryCodes

Discussion

If set to YES, routeCountriesForRouteWithId: will return valid country codes after calculation. Default is NO.

Declared In

SKRouteSettings.h

  requestAdvices

If set to YES, the route can be used for turn by turn navigation and getRouteAdviceList will return valid advices. Default is YES.

@property (nonatomic, assign) BOOL requestAdvices

Discussion

If set to YES, the route can be used for turn by turn navigation and getRouteAdviceList will return valid advices. Default is YES.

Declared In

SKRouteSettings.h

  requestTurningRoutePoints

If set to YES, routeTurningPointsAsGPSPointsForRouteWithId / routeTurningPointsAsMercatorPointsForRouteWithId will return valid turning points (the points where advices take place) after calculation. Default is NO.

@property (nonatomic, assign) BOOL requestTurningRoutePoints

Discussion

If set to YES, routeTurningPointsAsGPSPointsForRouteWithId / routeTurningPointsAsMercatorPointsForRouteWithId will return valid turning points (the points where advices take place) after calculation. Default is NO.

Declared In

SKRouteSettings.h

  renderRouteAsDottedLine

If set to YES, the route will be rendered as dotted line. It works only if the route mode is set as SKRouteModePedestrian. By default it is set to YES.

@property (nonatomic, assign) BOOL renderRouteAsDottedLine

Discussion

If set to YES, the route will be rendered as dotted line. It works only if the route mode is set as SKRouteModePedestrian. By default it is set to YES.

Declared In

SKRouteSettings.h

  maximumReturnedRoutes

The maximum number of routes returned by the SDK. Default value is 1. In some cases you would like to calculate more routes then the number specified by this property and to get the best routes limited by this number. For configuring the desired alternative routes please see the documentation of the SKRouteAlternativeSettings class.

@property (nonatomic, assign) NSUInteger maximumReturnedRoutes

Discussion

The maximum number of routes returned by the SDK. Default value is 1. In some cases you would like to calculate more routes then the number specified by this property and to get the best routes limited by this number. For configuring the desired alternative routes please see the documentation of the SKRouteAlternativeSettings class.

Declared In

SKRouteSettings.h

  alternativeRouteCalculations

Route calculation modes for alternative routes, an array of SKRouteAlternativeSettings objects. If nil, default alternatives will be generated.

@property (nonatomic, strong) NSArray<SKRouteAlternativeSettings*> *alternativeRouteCalculations

Discussion

Route calculation modes for alternative routes, an array of SKRouteAlternativeSettings objects. If nil, default alternatives will be generated.

Declared In

SKRouteSettings.h

  useSlopes

Indicates whether to use the roads' slopes when calculating the route.

@property (nonatomic, assign) BOOL useSlopes

Discussion

Indicates whether to use the roads' slopes when calculating the route.

Declared In

SKRouteSettings.h

  requestExtendedRoutePointsInfo

If set to YES, routeCoordinatesForRouteWithId: coordinates will also contain elevation data. Will be slower to calculate. Default is NO.

@property (nonatomic, assign) BOOL requestExtendedRoutePointsInfo

Discussion

If set to YES, routeCoordinatesForRouteWithId: coordinates will also contain elevation data. Will be slower to calculate. Default is NO.

Declared In

SKRouteSettings.h

  downloadRouteCorridor

Indicates whether to download the tiles of the route corridor.

@property (nonatomic, assign) BOOL downloadRouteCorridor

Discussion

Indicates whether to download the tiles of the route corridor.

Declared In

SKRouteSettings.h

  routeCorridorWidth

It specifies the route corridor width, in meters. The corridor will have routeCorridorWidth on both sides of the route.

@property (nonatomic, assign) NSInteger routeCorridorWidth

Discussion

It specifies the route corridor width, in meters. The corridor will have routeCorridorWidth on both sides of the route.

Declared In

SKRouteSettings.h

  waitForCorridorDownload

Indicates whether to wait for the corridor download before sending the route calculation finished callback.

@property (nonatomic, assign) BOOL waitForCorridorDownload

Discussion

Indicates whether to wait for the corridor download before sending the route calculation finished callback.

Declared In

SKRouteSettings.h

  destinationIsPoint

Indicates whether the destination is a specific point ( POI, street with house number, etc. ) or not ( a street, a city ). This affects audio advices for reaching the destination.

@property (nonatomic, assign) BOOL destinationIsPoint

Discussion

Indicates whether the destination is a specific point ( POI, street with house number, etc. ) or not ( a street, a city ). This affects audio advices for reaching the destination.

Declared In

SKRouteSettings.h

+ routeSettings

Creates a newly initialized SKRouteSettings object.

+ (instancetype)routeSettings

Discussion

Creates a newly initialized SKRouteSettings object.

Declared In

SKRouteSettings.h