Find route

View on GitHub
Sample viewer app

Display directions for a route between two points.

screenshot

Use case

Find routes with driving directions between any number of locations. You might use the ArcGIS platform to create a custom network for routing on a private roads.

How to use the sample

For simplicity, the sample comes loaded with a start and end stop. You can click on the Find Route to display a route between these stops. Once the route is generated, turn-by-turn directions are shown in a list.

How it works

  1. Create a RouteTask using a URL to an online route service.
  2. Generate default RouteParameters using routeTask::createDefaultParameters().
  3. Set returnStops and returnDirections on the parameters to true.
  4. Add Stops to the parameters stops collection for each destination.
  5. Solve the route using routeTask::solveRoute(routeParameters) to get a RouteResult.
  6. Iterate through the result's Routes. To display the route, create a graphic using the geometry from route::routeGeometry(). To display directions, use route::directionManeuvers() and apply the list model to the UI.

Relevant API

  • DirectionManeuver
  • Route
  • RouteParameters
  • RouteResult
  • RouteTask
  • Stop

Tags

directions, driving, navigation, network, network analysis, route, routing, shortest path, turn-by-turn

Sample Code

FindRoute.cppFindRoute.cppFindRoute.hFindRoute.qml
Use dark colors for code blocksCopy
                                                                                                                                                                                                      
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
// [WriteFile Name=FindRoute, Category=Routing]
// [Legal]
// Copyright 2016 Esri.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

#include "FindRoute.h"

#include "Map.h"
#include "MapQuickView.h"
#include "Basemap.h"
#include "ArcGISVectorTiledLayer.h"
#include "GraphicsOverlay.h"
#include "Viewpoint.h"
#include "Point.h"
#include "SpatialReference.h"
#include "SimpleRenderer.h"
#include "SimpleLineSymbol.h"
#include "PictureMarkerSymbol.h"
#include "RouteTask.h"
#include "RouteParameters.h"
#include "Stop.h"

using namespace Esri::ArcGISRuntime;

FindRoute::FindRoute(QQuickItem* parent) :
  QQuickItem(parent)
{
}

FindRoute::~FindRoute() = default;

void FindRoute::init()
{
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterUncreatableType<QAbstractListModel>("Esri.Samples", 1, 0, "AbstractListModel", "AbstractListModel is uncreateable");
  qmlRegisterType<FindRoute>("Esri.Samples", 1, 0, "FindRouteSample");
}

void FindRoute::componentComplete()
{
  QQuickItem::componentComplete();

  // find QML MapView component
  m_mapView = findChild<MapQuickView*>("mapView");

  // create a new basemap instance
  Basemap* basemap = new Basemap(BasemapStyle::ArcGISNavigation, this);

  // create a new map instance
  m_map = new Map(basemap, this);
  m_map->setInitialViewpoint(Viewpoint(Point(-13041154, 3858170, SpatialReference(3857)), 1e5));

  // set map on the map view
  m_mapView->setMap(m_map);

  // create initial graphics overlays
  m_routeGraphicsOverlay = new GraphicsOverlay(this);
  SimpleLineSymbol* simpleLineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle::Solid, QColor("cyan"), 4, this);
  SimpleRenderer* simpleRenderer = new SimpleRenderer(simpleLineSymbol, this);
  m_routeGraphicsOverlay->setRenderer(simpleRenderer);
  m_stopsGraphicsOverlay = new GraphicsOverlay(this);
  m_mapView->graphicsOverlays()->append(m_routeGraphicsOverlay);
  m_mapView->graphicsOverlays()->append(m_stopsGraphicsOverlay);

  // connect to loadStatusChanged signal
  connect(m_map, &Map::loadStatusChanged, this, [this](LoadStatus loadStatus)
  {
    if (loadStatus == LoadStatus::Loaded)
    {
      addStopGraphics();
      setupRouteTask();
    }
  });
}

void FindRoute::addStopGraphics()
{
  //! [FindRoute cpp addStopGraphics]
  // create the stop graphics' geometry
  Point stop1Geometry(-13041171, 3860988, SpatialReference(3857));
  Point stop2Geometry(-13041693, 3856006, SpatialReference(3857));

  // create the stop graphics' symbols
  PictureMarkerSymbol* stop1Symbol = getPictureMarkerSymbol(QUrl("qrc:/Samples/Routing/FindRoute/pinA.png"));
  PictureMarkerSymbol* stop2Symbol = getPictureMarkerSymbol(QUrl("qrc:/Samples/Routing/FindRoute/pinB.png"));

  // create the stop graphics
  Graphic* stop1Graphic = new Graphic(stop1Geometry, stop1Symbol, this);
  Graphic* stop2Graphic = new Graphic(stop2Geometry, stop2Symbol, this);

  // add to the overlay
  m_stopsGraphicsOverlay->graphics()->append(stop1Graphic);
  m_stopsGraphicsOverlay->graphics()->append(stop2Graphic);
  //! [FindRoute cpp addStopGraphics]
}

// Helper function for creating picture marker symbols
PictureMarkerSymbol* FindRoute::getPictureMarkerSymbol(QUrl imageUrl)
{
  PictureMarkerSymbol* pictureMarkerSymbol = new PictureMarkerSymbol(imageUrl, this);
  pictureMarkerSymbol->setWidth(32);
  pictureMarkerSymbol->setHeight(32);
  pictureMarkerSymbol->setOffsetY(16);
  return pictureMarkerSymbol;
}

void FindRoute::setupRouteTask()
{
  //! [FindRoute new RouteTask]
  // create the route task pointing to an online service
  m_routeTask = new RouteTask(QUrl("https://sampleserver6.arcgisonline.com/arcgis/rest/services/NetworkAnalysis/SanDiego/NAServer/Route"), this);

  // connect to loadStatusChanged signal
  connect(m_routeTask, &RouteTask::loadStatusChanged, this, [this](LoadStatus loadStatus)
  {
    if (loadStatus == LoadStatus::Loaded)
    {
      // Request default parameters once the task is loaded
      m_routeTask->createDefaultParameters();
    }
  });
  //! [FindRoute new RouteTask]

  //! [FindRoute connect RouteTask signals]
  // connect to createDefaultParametersCompleted signal
  connect(m_routeTask, &RouteTask::createDefaultParametersCompleted, this, [this](QUuid, RouteParameters routeParameters)
  {
    // Store the resulting route parameters
    m_routeParameters = routeParameters;
  });

  // connect to solveRouteCompleted signal
  connect(m_routeTask, &RouteTask::solveRouteCompleted, this, [this](QUuid, RouteResult routeResult)
  {
    // Add the route graphic once the solve completes
    Route generatedRoute = routeResult.routes().at(0);
    Graphic* routeGraphic = new Graphic(generatedRoute.routeGeometry(), this);
    m_routeGraphicsOverlay->graphics()->append(routeGraphic);

    // set the direction maneuver list model
    m_directions = generatedRoute.directionManeuvers(this);
    emit directionsChanged();

    // emit that the route has solved successfully
    emit solveRouteComplete();
  });
  //! [FindRoute connect RouteTask signals]

  // load the route task
  m_routeTask->load();
}

QAbstractListModel* FindRoute::directions()
{
  return m_directions;
}

//! [FindRoute solveRoute]
void FindRoute::solveRoute()
{
  if (m_routeTask->loadStatus() == LoadStatus::Loaded)
  {
    if (!m_routeParameters.isEmpty())
    {
      // set parameters to return directions
      m_routeParameters.setReturnDirections(true);

      // clear previous stops from the parameters
      m_routeParameters.clearStops();

      // set the stops to the parameters
      Stop stop1(m_stopsGraphicsOverlay->graphics()->at(0)->geometry());
      stop1.setName("Origin");
      Stop stop2(m_stopsGraphicsOverlay->graphics()->at(1)->geometry());
      stop2.setName("Destination");
      m_routeParameters.setStops(QList<Stop> { stop1, stop2 });

      // solve the route with the parameters
      m_routeTask->solveRoute(m_routeParameters);
    }
  }
}
//! [FindRoute solveRoute]

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.