com.navigine.idl.java.RouteOptions Class Reference

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

Public Member Functions
	RouteOptions (Double smoothRadius, Double maxProjectionDistance, Double maxAdvance)
	Default constructor for class RouteOptions.
Double	getSmoothRadius ()
	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.
Double	getMaxProjectionDistance ()
	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.
Double	getMaxAdvance ()
	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.
String	toString ()

Detailed Description

Class is used for describing routing options of AsyncRouteManager.

Referenced from: AsyncRouteManager.

Java code snippet:

        // Create route options with custom parameters
        RouteOptions routeOptions = new RouteOptions(3.0, 7.0, 2.5);
        System.out.println("Created route options with smoothRadius: " + routeOptions.getSmoothRadius() +
                          ", maxProjectionDistance: " + routeOptions.getMaxProjectionDistance() +
                          ", maxAdvance: " + routeOptions.getMaxAdvance());

Kotlin code snippet:

        // Create route options with custom parameters
        val routeOptions = RouteOptions(3.0, 7.0, 2.5)
        println("Created route options with smoothRadius: ${routeOptions.smoothRadius}, maxProjectionDistance: ${routeOptions.maxProjectionDistance}, maxAdvance: ${routeOptions.maxAdvance}")

Definition at line 24 of file RouteOptions.java.

Constructor & Destructor Documentation

RouteOptions()

com.navigine.idl.java.RouteOptions.RouteOptions ( Double smoothRadius, Double maxProjectionDistance, Double maxAdvance )

inline

Default constructor for class RouteOptions.

Definition at line 36 of file RouteOptions.java.

Member Function Documentation

getMaxAdvance()

Double com.navigine.idl.java.RouteOptions.getMaxAdvance ( )

inline

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.

Returns

Definition at line 73 of file RouteOptions.java.

getMaxProjectionDistance()

Double com.navigine.idl.java.RouteOptions.getMaxProjectionDistance ( )

inline

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.

Returns

Definition at line 63 of file RouteOptions.java.

getSmoothRadius()

Double com.navigine.idl.java.RouteOptions.getSmoothRadius ( )

inline

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.

Returns

Definition at line 52 of file RouteOptions.java.

toString()

String com.navigine.idl.java.RouteOptions.toString ( )

inline

Definition at line 78 of file RouteOptions.java.

---

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

• RouteOptions.java