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

Public Member Functions
native boolean	isValid ()

void	setVisible (boolean visible)
	Shows or hides the route layer.

boolean	isVisible ()
	Returns true if the route layer is visible.

void	setTarget (RouteEndpoint target)
	Starts turn-by-turn guidance to the target from the current position.

void	setRoute (RouteEndpoint from, RouteEndpoint to)
	Builds and shows a static route between two points (no live guidance).

void	clear ()
	Cancels guidance / static route and removes polylines from the map.

ArrayList< RouteView >	routes ()
	Returns currently rendered routes. V1 exposes a single active route.

RouteView	selectedRoute ()
	Returns selected route view, or null when no route is selected.

void	selectRoute (RouteView route)
	Selects the provided route view. Pass null to clear selection.

void	addRouteLayerListener (RouteLayerListener listener)
	Adds listener for route lifecycle, progress and target reach events.

void	removeRouteLayerListener (RouteLayerListener listener)
	Removes previously added route layer listener.

void	addRouteViewListener (RouteViewListener listener)
	Adds listener for route view list, selection and tap events.

void	removeRouteViewListener (RouteViewListener listener)
	Removes previously added route view listener.

void	setTraveledColor (int color)
	Sets traveled (passed) route polyline color.

void	setRemainingColor (int color)
	Sets remaining route polyline color.

void	setWidth (float width)
	Sets route polyline width in pixels (also used as default dotted point size).

void	setRemainingStyle (RouteRemainingStyle style)
	Sets rendering style for the remaining route.

RouteRemainingStyle	remainingStyle ()
	Returns the remaining route rendering style.

void	setRemainingDashLength (float dashLength)
	Sets dash length for DASHED remaining style. Use 0 to disable dashing.

void	setRemainingGapLength (float gapLength)
	Sets gap length for DASHED remaining style. Use 0 to disable dashing.

void	setRemainingPointSize (float width, float height)
	Sets point size for DOTTED remaining style.

void	setRemainingPlacement (Placement placement)
	Sets point placement mode for DOTTED remaining style.

void	setRemainingPlacementSpacing (float spacing)
	Sets spacing between points for DOTTED + SPACED placement (pixels).

void	setRemainingPlacementMinRatio (float ratio)
	Sets minimum polyline length ratio for DOTTED placement.

void	setRemainingCollisionEnabled (boolean enabled)
	Enables or disables collision for DOTTED remaining points.

Protected Attributes
Subscription< RouteLayerListener >	weakRouteLayerListenerSubscription

Subscription< RouteViewListener >	weakRouteViewListenerSubscription

Detailed Description

Definition at line 18 of file RouteLayerBinding.java.

Member Function Documentation

◆ addRouteLayerListener()

void com.navigine.idl.java.internal.RouteLayerBinding.addRouteLayerListener ( RouteLayerListener listener )

inline

Adds listener for route lifecycle, progress and target reach events.

Java code snippet:

        routeLayerListener = new RouteLayerListener() {
            @Override
            public void onRouteChanged(RouteLayerStatus status, RouteView route) {
                System.out.println("Route status: " + status);
            }
 
            @Override
            public void onRouteAdvanced(RouteProgress progress) {
                System.out.println("Remaining distance: " + progress.remainingDistance
                    + ", time: " + progress.remainingTime + "s");
            }
 
            @Override
            public void onRouteTargetReached() {
                System.out.println("Route target reached");
            }
        };
        routeLayer.addRouteLayerListener(routeLayerListener);

Kotlin code snippet:

        routeLayerListener = object : RouteLayerListener {
            override fun onRouteChanged(status: RouteLayerStatus, route: RouteView?) {
                println("Route status: $status")
            }
 
            override fun onRouteAdvanced(progress: RouteProgress) {
                println("Remaining distance: ${progress.remainingDistance}, time: ${progress.remainingTime}s")
            }
 
            override fun onRouteTargetReached() {
                println("Route target reached")
            }
        }
        routeLayer!!.addRouteLayerListener(routeLayerListener!!)

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 105 of file RouteLayerBinding.java.

◆ addRouteViewListener()

void com.navigine.idl.java.internal.RouteLayerBinding.addRouteViewListener ( RouteViewListener listener )

inline

Adds listener for route view list, selection and tap events.

Java code snippet:

        routeViewListener = new RouteViewListener() {
            @Override
            public void onRouteViewsChanged() {
                System.out.println("Route views changed");
            }
 
            @Override
            public void onSelectedRouteChanged(RouteView route) {
                System.out.println("Selected route changed");
            }
 
            @Override
            public void onRouteViewTap(RouteView route) {
                routeLayer.selectRoute(route);
            }
        };
        routeLayer.addRouteViewListener(routeViewListener);

Kotlin code snippet:

        routeViewListener = object : RouteViewListener {
            override fun onRouteViewsChanged() {
                println("Route views changed")
            }
 
            override fun onSelectedRouteChanged(route: RouteView?) {
                println("Selected route changed")
            }
 
            override fun onRouteViewTap(route: RouteView) {
                routeLayer!!.selectRoute(route)
            }
        }
        routeLayer!!.addRouteViewListener(routeViewListener!!)

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 119 of file RouteLayerBinding.java.

◆ clear()

void com.navigine.idl.java.internal.RouteLayerBinding.clear ( )

inline

Cancels guidance / static route and removes polylines from the map.

Java code snippet:

routeLayer.clear();

System.out.println("Route layer cleared");

Kotlin code snippet:

routeLayer!!.clear()

println("Route layer cleared")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 77 of file RouteLayerBinding.java.

◆ isValid()

native boolean com.navigine.idl.java.internal.RouteLayerBinding.isValid ( )

Tells if this RouteLayer is valid or not. Any other method (except for this one) called on an invalid RouteLayer will throw java.lang.RuntimeException.

Reimplemented from com.navigine.idl.java.RouteLayer.

◆ isVisible()

boolean com.navigine.idl.java.internal.RouteLayerBinding.isVisible ( )

inline

Returns true if the route layer is visible.

Java code snippet:

boolean visible = routeLayer.isVisible();

System.out.println("Route layer is visible: " + visible);

Kotlin code snippet:

val visible = routeLayer!!.isVisible

println("Route layer is visible: $visible")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 56 of file RouteLayerBinding.java.

◆ remainingStyle()

RouteRemainingStyle com.navigine.idl.java.internal.RouteLayerBinding.remainingStyle ( )

inline

Returns the remaining route rendering style.

Java code snippet:

RouteRemainingStyle remainingStyle = routeLayer.remainingStyle();

System.out.println("Remaining style: " + remainingStyle);

Kotlin code snippet:

val remainingStyle = routeLayer!!.remainingStyle

println("Remaining style: $remainingStyle")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 161 of file RouteLayerBinding.java.

◆ removeRouteLayerListener()

void com.navigine.idl.java.internal.RouteLayerBinding.removeRouteLayerListener ( RouteLayerListener listener )

inline

Removes previously added route layer listener.

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 112 of file RouteLayerBinding.java.

◆ removeRouteViewListener()

void com.navigine.idl.java.internal.RouteLayerBinding.removeRouteViewListener ( RouteViewListener listener )

inline

Removes previously added route view listener.

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 126 of file RouteLayerBinding.java.

◆ routes()

ArrayList< RouteView > com.navigine.idl.java.internal.RouteLayerBinding.routes ( )

inline

Returns currently rendered routes. V1 exposes a single active route.

Java code snippet:

List<RouteView> routes = routeLayer.routes();

System.out.println("Visible routes: " + routes.size());

Kotlin code snippet:

val routes = routeLayer!!.routes()

println("Visible routes: ${routes.size}")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 84 of file RouteLayerBinding.java.

◆ selectedRoute()

RouteView com.navigine.idl.java.internal.RouteLayerBinding.selectedRoute ( )

inline

Returns selected route view, or null when no route is selected.

Java code snippet:

        RouteView selectedRoute = routeLayer.selectedRoute();
        if (selectedRoute != null) {
            System.out.println("Selected route length: " + selectedRoute.length());
        }

Kotlin code snippet:

        val selectedRoute = routeLayer!!.selectedRoute()
        if (selectedRoute != null) {
            println("Selected route length: ${selectedRoute.length()}")
        }

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 91 of file RouteLayerBinding.java.

◆ selectRoute()

void com.navigine.idl.java.internal.RouteLayerBinding.selectRoute ( RouteView route )

inline

Selects the provided route view. Pass null to clear selection.

Parameters

route Route view from routes, or null.

Java code snippet:

        if (!routes.isEmpty()) {
            routeLayer.selectRoute(routes.get(0));
        }

Kotlin code snippet:

routes.firstOrNull()?.let { routeLayer!!.selectRoute(it) }

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 98 of file RouteLayerBinding.java.

◆ setRemainingCollisionEnabled()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingCollisionEnabled ( boolean enabled )

inline

Enables or disables collision for DOTTED remaining points.

Java code snippet:

routeLayer.setRemainingCollisionEnabled(false);

System.out.println("Remaining collision disabled");

Kotlin code snippet:

routeLayer!!.setRemainingCollisionEnabled(false)

println("Remaining collision disabled")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 210 of file RouteLayerBinding.java.

◆ setRemainingColor()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingColor ( int color )

inline

Sets remaining route polyline color.

Java code snippet:

routeLayer.setRemainingColor(0xFF30AAD9);

System.out.println("Remaining color updated");

Kotlin code snippet:

routeLayer!!.setRemainingColor(0xFF30AAD9.toInt())

println("Remaining color updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 140 of file RouteLayerBinding.java.

◆ setRemainingDashLength()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingDashLength ( float dashLength )

inline

Sets dash length for DASHED remaining style. Use 0 to disable dashing.

Java code snippet:

routeLayer.setRemainingDashLength(0.5f);

System.out.println("Remaining dash length updated");

Kotlin code snippet:

routeLayer!!.setRemainingDashLength(0.5f)

println("Remaining dash length updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 168 of file RouteLayerBinding.java.

◆ setRemainingGapLength()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingGapLength ( float gapLength )

inline

Sets gap length for DASHED remaining style. Use 0 to disable dashing.

Java code snippet:

routeLayer.setRemainingGapLength(0.4f);

System.out.println("Remaining gap length updated");

Kotlin code snippet:

routeLayer!!.setRemainingGapLength(0.4f)

println("Remaining gap length updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 175 of file RouteLayerBinding.java.

◆ setRemainingPlacement()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingPlacement ( Placement placement )

inline

Sets point placement mode for DOTTED remaining style.

Java code snippet:

routeLayer.setRemainingPlacement(Placement.SPACED);

System.out.println("Remaining placement updated");

Kotlin code snippet:

routeLayer!!.setRemainingPlacement(Placement.SPACED)

println("Remaining placement updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 189 of file RouteLayerBinding.java.

◆ setRemainingPlacementMinRatio()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingPlacementMinRatio ( float ratio )

inline

Sets minimum polyline length ratio for DOTTED placement.

Java code snippet:

routeLayer.setRemainingPlacementMinRatio(0.0f);

System.out.println("Remaining placement min ratio updated");

Kotlin code snippet:

routeLayer!!.setRemainingPlacementMinRatio(0.0f)

println("Remaining placement min ratio updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 203 of file RouteLayerBinding.java.

◆ setRemainingPlacementSpacing()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingPlacementSpacing ( float spacing )

inline

Sets spacing between points for DOTTED + SPACED placement (pixels).

Java code snippet:

routeLayer.setRemainingPlacementSpacing(8.0f);

System.out.println("Remaining placement spacing updated");

Kotlin code snippet:

routeLayer!!.setRemainingPlacementSpacing(8.0f)

println("Remaining placement spacing updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 196 of file RouteLayerBinding.java.

◆ setRemainingPointSize()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingPointSize	(	float	width,
		float	height )

inline

Sets point size for DOTTED remaining style.

Java code snippet:

routeLayer.setRemainingPointSize(8.0f, 8.0f);

System.out.println("Remaining point size updated");

Kotlin code snippet:

routeLayer!!.setRemainingPointSize(8.0f, 8.0f)

println("Remaining point size updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 182 of file RouteLayerBinding.java.

◆ setRemainingStyle()

void com.navigine.idl.java.internal.RouteLayerBinding.setRemainingStyle ( RouteRemainingStyle style )

inline

Sets rendering style for the remaining route.

Java code snippet:

routeLayer.setRemainingStyle(RouteRemainingStyle.DOTTED);

System.out.println("Remaining style set to DOTTED");

Kotlin code snippet:

routeLayer!!.setRemainingStyle(RouteRemainingStyle.DOTTED)

println("Remaining style set to DOTTED")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 154 of file RouteLayerBinding.java.

◆ setRoute()

void com.navigine.idl.java.internal.RouteLayerBinding.setRoute	(	RouteEndpoint	from,
		RouteEndpoint	to )

inline

Builds and shows a static route between two points (no live guidance).

Parameters

from	Route start endpoint.
to	Route finish endpoint.

Java code snippet:

routeLayer.setRoute(from, to);

System.out.println("Static route applied");

Kotlin code snippet:

routeLayer!!.setRoute(from, to)

println("Static route applied")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 70 of file RouteLayerBinding.java.

◆ setTarget()

void com.navigine.idl.java.internal.RouteLayerBinding.setTarget ( RouteEndpoint target )

inline

Starts turn-by-turn guidance to the target from the current position.

Parameters

target Destination endpoint. Route and progress are updated automatically.

Java code snippet:

routeLayer.setTarget(to);

System.out.println("Guidance target applied");

Kotlin code snippet:

routeLayer!!.setTarget(to)

println("Guidance target applied")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 63 of file RouteLayerBinding.java.

◆ setTraveledColor()

void com.navigine.idl.java.internal.RouteLayerBinding.setTraveledColor ( int color )

inline

Sets traveled (passed) route polyline color.

Java code snippet:

routeLayer.setTraveledColor(0xB4787878);

System.out.println("Traveled color updated");

Kotlin code snippet:

routeLayer!!.setTraveledColor(0xB4787878.toInt())

println("Traveled color updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 133 of file RouteLayerBinding.java.

◆ setVisible()

void com.navigine.idl.java.internal.RouteLayerBinding.setVisible ( boolean visible )

inline

Shows or hides the route layer.

Java code snippet:

routeLayer.setVisible(true);

System.out.println("Route layer set visible");

Kotlin code snippet:

routeLayer!!.setVisible(true)

println("Route layer set visible")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 49 of file RouteLayerBinding.java.

◆ setWidth()

void com.navigine.idl.java.internal.RouteLayerBinding.setWidth ( float width )

inline

Sets route polyline width in pixels (also used as default dotted point size).

Java code snippet:

routeLayer.setWidth(8.0f);

System.out.println("Route width updated");

Kotlin code snippet:

routeLayer!!.setWidth(8.0f)

println("Route width updated")

Reimplemented from com.navigine.idl.java.RouteLayer.

Definition at line 147 of file RouteLayerBinding.java.

Member Data Documentation

◆ weakRouteLayerListenerSubscription

Subscription<RouteLayerListener> com.navigine.idl.java.internal.RouteLayerBinding.weakRouteLayerListenerSubscription

protected

Initial value:

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

Definition at line 27 of file RouteLayerBinding.java.

◆ weakRouteViewListenerSubscription

Subscription<RouteViewListener> com.navigine.idl.java.internal.RouteLayerBinding.weakRouteViewListenerSubscription

protected

Initial value:

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

Definition at line 35 of file RouteLayerBinding.java.

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

RouteLayerBinding.java

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addRouteLayerListener()

◆ addRouteViewListener()

◆ clear()

◆ isValid()

◆ isVisible()

◆ remainingStyle()

◆ removeRouteLayerListener()

◆ removeRouteViewListener()

◆ routes()

◆ selectedRoute()

◆ selectRoute()

◆ setRemainingCollisionEnabled()

◆ setRemainingColor()

◆ setRemainingDashLength()

◆ setRemainingGapLength()

◆ setRemainingPlacement()

◆ setRemainingPlacementMinRatio()

◆ setRemainingPlacementSpacing()

◆ setRemainingPointSize()

◆ setRemainingStyle()

◆ setRoute()

◆ setTarget()

◆ setTraveledColor()

◆ setVisible()

◆ setWidth()

Member Data Documentation

◆ weakRouteLayerListenerSubscription

◆ weakRouteViewListenerSubscription