Loading...
Searching...
No Matches
Public Member Functions | List of all members
RouteManager Class Referenceabstract
Dart Classes | Dart Classes » Dart Managers

Class is used for evaluating RoutePath from point to point. More...

Inherits Finalizable.

Public Member Functions

RoutePath makeRoute (LocationPoint from, LocationPoint to)
 Method is used to build a route between points about evaluated RoutePath from your position to target point.
 
List< RoutePath > makeRoutes (LocationPoint from, List< LocationPoint > to)
 Method is used to build a route between the starting point and several destination points.
 
void setTarget (LocationPoint target)
 Method is used to set target point in your location. Through RouteListener you will be notified about new paths to target point.
 
void addTarget (LocationPoint target)
 Method is used to add target point in your location. Through RouteListener you will be notified about new paths to target point.
 
void cancelTarget ()
 Method is used for removing current target points to where the routes were built.
 
void clearTargets ()
 Method is used for removing all target points to where the routes were built.
 
void setGraphTag (String tag)
 Method is used to select graph tag (Default: "default").
 
String getGraphTag ()
 Method is used to get current graph tag (Default: "default").
 
List< String > getGraphTags ()
 Method is used to get all graph tags,.
 
void addRouteListener (RouteListener listener)
 Method is used to add RouteListener class element which will notify about evaluated route path from your position to target point.
 
void removeRouteListener (RouteListener listener)
 Method is used for removing previously added RouteListener class element.
 

Detailed Description

Class is used for evaluating RoutePath from point to point.

Referenced from NavigineSdk.

Definition at line 21 of file route_manager.dart.

Member Function Documentation

◆ addRouteListener()

void RouteManager.addRouteListener ( RouteListener listener)

Method is used to add RouteListener class element which will notify about evaluated route path from your position to target point.

Note
Do not forget to remove listener if it is no longer needed!
Parameters
listenerСorresponding RouteListener class.

Dart code snippet:

// Add route listener
_routeManager!.addRouteListener(_routeListener!);

◆ addTarget()

void RouteManager.addTarget ( LocationPoint target)

Method is used to add target point in your location. Through RouteListener you will be notified about new paths to target point.

Parameters
targetfinish LocationPoint.

Dart code snippet:

// Add additional target point
LocationPoint additionalTarget = LocationPoint(point: Point(x: 90.0, y: 100.0), locationId: 12345, sublocationId: 1);
_routeManager!.addTarget(additionalTarget);

◆ cancelTarget()

void RouteManager.cancelTarget ( )

Method is used for removing current target points to where the routes were built.

Dart code snippet:

// Cancel current target
_routeManager!.cancelTarget();

◆ clearTargets()

void RouteManager.clearTargets ( )

Method is used for removing all target points to where the routes were built.

Dart code snippet:

// Clear all targets
_routeManager!.clearTargets();

◆ getGraphTag()

String RouteManager.getGraphTag ( )

Method is used to get current graph tag (Default: "default").

Dart code snippet:

// Get current graph tag
String currentGraphTag = _routeManager!.getGraphTag();
print("Current graph tag: $currentGraphTag");

◆ getGraphTags()

List< String > RouteManager.getGraphTags ( )

Method is used to get all graph tags,.

Dart code snippet:

// Get all graph tags
List<String> graphTags = _routeManager!.getGraphTags();
print("Available graph tags: $graphTags");

◆ makeRoute()

RoutePath RouteManager.makeRoute ( LocationPoint from,
LocationPoint to )

Method is used to build a route between points about evaluated RoutePath from your position to target point.

Parameters
fromstarting LocationPoint.
todestination LocationPoint.
Returns
RoutePath from starting to destination point.

Dart code snippet:

// Make route from point to point
RoutePath routePath = _routeManager!.makeRoute(startLocationPoint, endLocationPoint);
print("Route created with length: ${routePath.length} meters");

◆ makeRoutes()

List< RoutePath > RouteManager.makeRoutes ( LocationPoint from,
List< LocationPoint > to )

Method is used to build a route between the starting point and several destination points.

Parameters
fromstarting LocationPoint.
todestination list of LocationPoints.
Returns
vector of RoutePaths from starting to destination point.

Dart code snippet:

// Make routes to multiple destinations
List<LocationPoint> destinations = [
LocationPoint(point: Point(x: 30.0, y: 40.0), locationId: 12345, sublocationId: 1),
LocationPoint(point: Point(x: 70.0, y: 80.0), locationId: 12345, sublocationId: 1),
];
List<RoutePath> routePaths = _routeManager!.makeRoutes(startLocationPoint, destinations);
print("Created ${routePaths.length} routes");

◆ removeRouteListener()

void RouteManager.removeRouteListener ( RouteListener listener)

Method is used for removing previously added RouteListener class element.

Parameters
listenerСorresponding RouteListener class to remove.

Dart code snippet:

// Remove route listener
_routeManager!.removeRouteListener(_routeListener!);

◆ setGraphTag()

void RouteManager.setGraphTag ( String tag)

Method is used to select graph tag (Default: "default").

Dart code snippet:

// Set graph tag
_routeManager!.setGraphTag("main");

◆ setTarget()

void RouteManager.setTarget ( LocationPoint target)

Method is used to set target point in your location. Through RouteListener you will be notified about new paths to target point.

Parameters
targetfinish LocationPoint.

Dart code snippet:

// Set target point
_routeManager!.setTarget(endLocationPoint);
The documentation for this class was generated from the following file: