Package com.navmii.sdk.routevisualization

Class RouteVisualizerRequest

java.lang.Object
com.navmii.sdk.routevisualization.RouteVisualizerRequest
public abstract class RouteVisualizerRequest
extends java.lang.Object
Interface describing route visualizer request. Executing an "empty" request doesn't affect the route visualizer state.

  • Constructor Details

  • Method Details

    • requestDisplayingWaypointMarkersAtCoordinates

      public abstract RouteVisualizerRequest requestDisplayingWaypointMarkersAtCoordinates​(java.util.ArrayList<MapCoordinates> coordinates, boolean considerFirstOneAsStart)
      Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will display waypoint markers on map.
      Parameters:
      coordinates - Waypoint marker coordinates. The last waypoint marker is always displayed with special image. Other markers are displayed with regular waypoint images except for the first one. The first marker, depending on the considerFirstOneAsStart parameter, is either displayed with regular image or with special image for start marker. Passing empty list indicates that all the existing markers should be removed from map.
      considerFirstOneAsStart - If 'true' is passed, the first waypoint marker is displayed with the special start image. Otherwise regular waypoint image is used.
      Returns:
      New request instance.

    • requestRemovingWaypointMarkers

      public abstract RouteVisualizerRequest requestRemovingWaypointMarkers()
      Creates a copy of the instance configured to remove all waypoint markers from map.
      Returns:
      New request instance.

    • requestDisplayingPolylineOfRoute

      public abstract RouteVisualizerRequest requestDisplayingPolylineOfRoute​(Route route)
      Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will display the polyline of the specified route on map.
      Parameters:
      route - A route whose polyline should be displayed on map. Passing 'null' indicates that the currently displayed route polyline should be removed from map.
      Returns:
      New request instance.

    • requestDisplayingPolylineAndWaypointsOfRoute

      public abstract RouteVisualizerRequest requestDisplayingPolylineAndWaypointsOfRoute​(Route route)
      Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will display the polyline of the specified route on map along with markers of its route plan.
      Parameters:
      route - Route whose polyline should be displayed on map and whose route plan should be used as coordinates of waypoints where markers should be placed. Passing 'null' indicates that route polyline and all waypoint markers should be removed from map.
      Returns:
      New request instance.

    • requestRemovingRoutePolyline

      public abstract RouteVisualizerRequest requestRemovingRoutePolyline()
      Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will remove еру displayed route polyline from map.
      Returns:
      New request instance.

    • requestDisplayingPolylinesOfAlternativeRoutes

      public abstract RouteVisualizerRequest requestDisplayingPolylinesOfAlternativeRoutes​(java.util.ArrayList<Route> routes)
      Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will display alternative routes' polylines on map. By default the polyline of an alternative route has gray color.
      Parameters:
      routes - Alternative routes whose polylines should be displayed on map. Passing empty list indicates all the alternative route polylines should be removed from map.
      Returns:
      New request instance.

    • requestRemovingAlternativeRoutePolylines

      public abstract RouteVisualizerRequest requestRemovingAlternativeRoutePolylines()
      Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will remove polylines of all the displayed alternative routes from map.
      Returns:
      New request instance.

    • requestRemovingAll

      public abstract RouteVisualizerRequest requestRemovingAll()
      Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will remove all the additional data from map.
      Returns:
      New request instance.

    • createRequestRemovingAll

      public static RouteVisualizerRequest createRequestRemovingAll()
      Creates a request configured to remove all the additional data from map.