NMRouteSnappingOptions Class Reference

Inherits <NSObject>.

Instance Methods
(nullable instancetype)	- init
(nullable instancetype)	- initInWalkingMode
(nullable instancetype)	- initWithTraffic:

Properties
BOOL	isWalkingMode
NMVehicleType	vehicleType
BOOL	avoidTollRoads
BOOL	considerTraffic
BOOL	useProvidedTimesToCalculateEta
NSInteger	maxSnappingDistanceInMeters
NMTrafficSnapshot *	trafficSnapshot

Method Documentation

init()

- (nullable instancetype) init

Initializes object with default values.

initInWalkingMode()

- (nullable instancetype) initInWalkingMode

Initializes object with default values except the isWalkingMode property, which is initialized with 'YES'.

initWithTraffic:()

- (nullable instancetype) initWithTraffic:

(nonnull NMTrafficSnapshot *)

trafficSnapshot

Initializes object with default values except the trafficSnapshot property, which is initialized with the specified traffic snapshot.

Parameters

trafficSnapshot

@nonnull Traffic snapshot to initialize object with.

Property Documentation

avoidTollRoads

- (BOOL) avoidTollRoads

readwritenonatomicassign

Specifies whether toll roads should be avoided. The property is ignored in walking mode.

Default value is 'NO'.

considerTraffic

- (BOOL) considerTraffic

readwritenonatomicassign

Specifies whether traffic should be considered during route calculation. The property is ignored in walking mode.

Default value is 'YES'.

isWalkingMode

- (BOOL) isWalkingMode

readwritenonatomicassign

Specifies whether walking mode is used.

Default value is 'NO'.

maxSnappingDistanceInMeters

- (NSInteger) maxSnappingDistanceInMeters

readwritenonatomicassign

Limits the distance being snapped at once. If the distance specified by this property is less than the route length, the remaining part of the route will be snapped while navigating. Setting this property to -1 indicates that snapping distance is unlimited and the whole route should be snapped immediately after obtaining the route. Please note that in case of the online version of the SDK setting large values or -1 may slow down the whole snapping process, because the SDK needs to downoad all the map tiles along the part of the route being snapped.

Default value is 100,000 meters.

trafficSnapshot

- (NMTrafficSnapshot*) trafficSnapshot

readwritenonatomicstrong

A traffic snapshot which is used in route calculation and visualisation of the route polyline. The source of the traffic snapshot is another SDK module. If you want to consider traffic in route calculation and display it on the route polyline after the route is calculated you need to set valid nonnull value to this property.

Default value is 'nil'.

useProvidedTimesToCalculateEta

- (BOOL) useProvidedTimesToCalculateEta

readwritenonatomicassign

Specifies whether the ETA of a route should be calculated using time data from the external route. If 'NO' is specified, the ETA is calculated based on the time data obtained from maps locally on the device. The property is ignored in walking mode.

Default value is 'YES'.

vehicleType

- (NMVehicleType) vehicleType

readwritenonatomicassign

Specifies vehicle type. The property is ignored in walking mode.

Default value is NMVehicleType_Car.