Inheritance diagram for com.navigine.idl.java.internal.RouteManagerBinding:

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.

ArrayList< RoutePath >	makeRoutes (LocationPoint from, ArrayList< 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").

ArrayList< 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.

Protected Member Functions
	RouteManagerBinding (NativeObject nativeObject)

Protected Attributes
Subscription< RouteListener >	weakRouteListenerSubscription

Detailed Description

Definition at line 15 of file RouteManagerBinding.java.

Constructor & Destructor Documentation

◆ RouteManagerBinding()

com.navigine.idl.java.internal.RouteManagerBinding.RouteManagerBinding ( NativeObject nativeObject )

inlineprotected

Invoked only from native code.

Definition at line 22 of file RouteManagerBinding.java.

Member Function Documentation

◆ addRouteListener()

void com.navigine.idl.java.internal.RouteManagerBinding.addRouteListener ( RouteListener listener )

inline

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 Corresponding RouteListener class.

Java code snippet:

// Add route listener

routeManager.addRouteListener(routeListener);

Kotlin code snippet:

// Add route listener

manager.addRouteListener(listener)

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 101 of file RouteManagerBinding.java.

◆ addTarget()

void com.navigine.idl.java.internal.RouteManagerBinding.addTarget ( LocationPoint target )

inline

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

Parameters

target finish LocationPoint.

Java code snippet:

        // Add additional target point
        LocationPoint additionalTarget = new LocationPoint(new Point(90.0, 100.0), 12345, 1);
        routeManager.addTarget(additionalTarget);

Kotlin code snippet:

        // Add additional target point
        val additionalTarget = LocationPoint(Point(90.0, 100.0), 12345, 1)
        manager.addTarget(additionalTarget)

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 59 of file RouteManagerBinding.java.

◆ cancelTarget()

void com.navigine.idl.java.internal.RouteManagerBinding.cancelTarget ( )

inline

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

Java code snippet:

// Cancel current target

routeManager.cancelTarget();

Kotlin code snippet:

// Cancel current target

manager.cancelTarget()

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 66 of file RouteManagerBinding.java.

◆ clearTargets()

void com.navigine.idl.java.internal.RouteManagerBinding.clearTargets ( )

inline

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

Java code snippet:

// Clear all targets

routeManager.clearTargets();

Kotlin code snippet:

// Clear all targets

manager.clearTargets()

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 73 of file RouteManagerBinding.java.

◆ getGraphTag()

String com.navigine.idl.java.internal.RouteManagerBinding.getGraphTag ( )

inline

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

Java code snippet:

        // Get current graph tag
        String currentGraphTag = routeManager.getGraphTag();
        System.out.println("Current graph tag: " + currentGraphTag);

Kotlin code snippet:

        // Get current graph tag
        val currentGraphTag = manager.getGraphTag()
        println("Current graph tag: $currentGraphTag")

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 87 of file RouteManagerBinding.java.

◆ getGraphTags()

ArrayList< String > com.navigine.idl.java.internal.RouteManagerBinding.getGraphTags ( )

inline

Method is used to get all graph tags,.

Java code snippet:

        // Get all graph tags
        List<String> graphTags = routeManager.getGraphTags();
        System.out.println("Available graph tags: " + graphTags);

Kotlin code snippet:

        // Get all graph tags
        val graphTags = manager.getGraphTags()
        println("Available graph tags: $graphTags")

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 94 of file RouteManagerBinding.java.

◆ makeRoute()

RoutePath com.navigine.idl.java.internal.RouteManagerBinding.makeRoute	(	LocationPoint	from,
		LocationPoint	to )

inline

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

Parameters

from	starting LocationPoint.
to	destination LocationPoint.

Returns: RoutePath from starting to destination point.

Java code snippet:

        // Make route from point to point
        RoutePath routePath = routeManager.makeRoute(startLocationPoint, endLocationPoint);
        System.out.println("Route created with length: " + routePath.getLength() + " meters");

Kotlin code snippet:

        // Make route from point to point
        val routePath = manager.makeRoute(startLocationPoint, endLocationPoint)
        println("Route created with length: ${routePath.length} meters")

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 38 of file RouteManagerBinding.java.

◆ makeRoutes()

ArrayList< RoutePath > com.navigine.idl.java.internal.RouteManagerBinding.makeRoutes	(	LocationPoint	from,
		ArrayList< LocationPoint >	to )

inline

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

Parameters

from	starting LocationPoint.
to	destination list of LocationPoints.

Returns: vector of RoutePaths from starting to destination point.

Java code snippet:

        // Make routes to multiple destinations
        List<LocationPoint> destinations = new ArrayList<>();
        destinations.add(new LocationPoint(new Point(30.0, 40.0), 12345, 1));
        destinations.add(new LocationPoint(new Point(70.0, 80.0), 12345, 1));
        List<RoutePath> routePaths = routeManager.makeRoutes(startLocationPoint, destinations);
        System.out.println("Created " + routePaths.size() + " routes");

Kotlin code snippet:

        // Make routes to multiple destinations
        val destinations = listOf(
            LocationPoint(Point(30.0, 40.0), 12345, 1),
            LocationPoint(Point(70.0, 80.0), 12345, 1)
        )
        val routePaths = manager.makeRoutes(startLocationPoint, destinations)
        println("Created ${routePaths.size} routes")

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 45 of file RouteManagerBinding.java.

◆ removeRouteListener()

void com.navigine.idl.java.internal.RouteManagerBinding.removeRouteListener ( RouteListener listener )

inline

Method is used for removing previously added RouteListener class element.

Parameters

listener Corresponding RouteListener class to remove.

Java code snippet:

// Remove route listener

routeManager.removeRouteListener(routeListener);

Kotlin code snippet:

// Remove route listener

manager.removeRouteListener(listener)

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 108 of file RouteManagerBinding.java.

◆ setGraphTag()

void com.navigine.idl.java.internal.RouteManagerBinding.setGraphTag ( String tag )

inline

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

Java code snippet:

// Set graph tag

routeManager.setGraphTag("main");

Kotlin code snippet:

// Set graph tag

manager.setGraphTag("main")

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 80 of file RouteManagerBinding.java.

◆ setTarget()

void com.navigine.idl.java.internal.RouteManagerBinding.setTarget ( LocationPoint target )

inline

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

Parameters

target finish LocationPoint.

Java code snippet:

// Set target point

routeManager.setTarget(endLocationPoint);

Kotlin code snippet:

// Set target point

manager.setTarget(endLocationPoint)

Reimplemented from com.navigine.idl.java.RouteManager.

Definition at line 52 of file RouteManagerBinding.java.

Member Data Documentation

◆ weakRouteListenerSubscription

Subscription<RouteListener> com.navigine.idl.java.internal.RouteManagerBinding.weakRouteListenerSubscription

protected

Initial value:

= new Subscription<RouteListener>() {
        @Override
        public NativeObject createNativeListener(RouteListener listener) {
            return createRouteListener(listener);
        }
    }

Definition at line 27 of file RouteManagerBinding.java.

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

RouteManagerBinding.java

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RouteManagerBinding()

Member Function Documentation

◆ addRouteListener()

◆ addTarget()

◆ cancelTarget()

◆ clearTargets()

◆ getGraphTag()

◆ getGraphTags()

◆ makeRoute()

◆ makeRoutes()

◆ removeRouteListener()

◆ setGraphTag()

◆ setTarget()

Member Data Documentation

◆ weakRouteListenerSubscription