Loading...
Searching...
No Matches

Class is used for describing routing options of AsyncRouteManager. More...

#include <com/navigine/idl/objc/NCRouteOptions.h>

Inherits NSObject.

Instance Methods

(nonnull instancetype) - initWithSmoothRadius:maxProjectionDistance:maxAdvance:
 Default constructor for class NCRouteOptions.
 

Class Methods

(nonnull instancetype) + routeOptionsWithSmoothRadius:maxProjectionDistance:maxAdvance:
 Factory method for class NCRouteOptions.
 

Properties

NSNumber * smoothRadius
 This parameter controls if the resulting route should be smoothed for better user experience. It can be considered as the maximum distance (in meters) by which the smoothed route can deviate from the original route. The original route follows exactly the edges of the route graph. If you don't want the route to be smoothed, use value 0. Default value is 0.
 
NSNumber * maxProjectionDistance
 This parameter controls the router behaviour in case if the position essentially deviates from the proposed route. If the position deviates more than the specified distance (in meters), then the route will be rebuilt. You should not set the maxProjectionDistance value too low. The reasonable interval of values is [3, 10]. Default value is 5.
 
NSNumber * maxAdvance
 This parameter controls the maximum distance (in meters) that a position can advance along the route between the two consecutive navigation solutions separated in time by 1 second. If this constraint is broken, the route will be completely rebuilt. The reasonable interval of values is [1, 3]. Default value is 2.
 

Detailed Description

Class is used for describing routing options of AsyncRouteManager.

Referenced from: AsyncRouteManager.

Definition at line 17 of file NCRouteOptions.h.

Method Documentation

◆ initWithSmoothRadius:maxProjectionDistance:maxAdvance:

- (nonnull instancetype) initWithSmoothRadius: (nullable NSNumber *) smoothRadius
maxProjectionDistance: (nullable NSNumber *) maxProjectionDistance
maxAdvance: (nullable NSNumber *) maxAdvance 

Default constructor for class NCRouteOptions.

◆ routeOptionsWithSmoothRadius:maxProjectionDistance:maxAdvance:

+ (nonnull instancetype) routeOptionsWithSmoothRadius: (nullable NSNumber *) smoothRadius
maxProjectionDistance: (nullable NSNumber *) maxProjectionDistance
maxAdvance: (nullable NSNumber *) maxAdvance 

Factory method for class NCRouteOptions.

Property Documentation

◆ maxAdvance

- (NSNumber*) maxAdvance
readnonatomicassign

This parameter controls the maximum distance (in meters) that a position can advance along the route between the two consecutive navigation solutions separated in time by 1 second. If this constraint is broken, the route will be completely rebuilt. The reasonable interval of values is [1, 3]. Default value is 2.

Definition at line 57 of file NCRouteOptions.h.

◆ maxProjectionDistance

- (NSNumber*) maxProjectionDistance
readnonatomicassign

This parameter controls the router behaviour in case if the position essentially deviates from the proposed route. If the position deviates more than the specified distance (in meters), then the route will be rebuilt. You should not set the maxProjectionDistance value too low. The reasonable interval of values is [3, 10]. Default value is 5.

Definition at line 49 of file NCRouteOptions.h.

◆ smoothRadius

- (NSNumber*) smoothRadius
readnonatomicassign

This parameter controls if the resulting route should be smoothed for better user experience. It can be considered as the maximum distance (in meters) by which the smoothed route can deviate from the original route. The original route follows exactly the edges of the route graph. If you don't want the route to be smoothed, use value 0. Default value is 0.

Definition at line 40 of file NCRouteOptions.h.


The documentation for this class was generated from the following file: