Offline routing

// [WriteFile Name=OfflineRouting, Category=Routing]
// [Legal]
// Copyright 2020 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

// sample headers
#include "OfflineRouting.h"

// ArcGIS Maps SDK headers
#include "ArcGISTiledLayer.h"
#include "Basemap.h"
#include "CompositeSymbol.h"
#include "Envelope.h"
#include "Error.h"
#include "GeometryEngine.h"
#include "Graphic.h"
#include "GraphicListModel.h"
#include "GraphicsOverlay.h"
#include "GraphicsOverlayListModel.h"
#include "IdentifyGraphicsOverlayResult.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "PictureMarkerSymbol.h"
#include "Point.h"
#include "Polyline.h"
#include "Route.h"
#include "RouteParameters.h"
#include "RouteResult.h"
#include "RouteTask.h"
#include "RouteTaskInfo.h"
#include "SimpleLineSymbol.h"
#include "SimpleRenderer.h"
#include "SpatialReference.h"
#include "Stop.h"
#include "SymbolTypes.h"
#include "TextSymbol.h"
#include "TileCache.h"
#include "TravelMode.h"

// Qt headers
#include <QFileInfo>
#include <QScopedPointer>
#include <QStandardPaths>
#include <QUuid>

// STL headers
#include <memory>

using namespace Esri::ArcGISRuntime;

// helper method to get cross platform data path
namespace
{
  QString defaultDataPath()
  {
    QString dataPath;

#ifdef Q_OS_IOS
    dataPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
#else
    dataPath = QStandardPaths::writableLocation(QStandardPaths::HomeLocation);
#endif

    return dataPath;
  }

  const QUrl pinUrl("qrc:/Samples/Routing/OfflineRouting/orange_symbol.png");
} // namespace

OfflineRouting::OfflineRouting(QObject* parent /* = nullptr */) :
  QObject(parent),
  m_pinSymbol(new PictureMarkerSymbol(pinUrl, this)),
  m_stopsOverlay(new GraphicsOverlay(this)),
  m_routeOverlay(new GraphicsOverlay(this))
{
  const QString folderLocation = QString("%1/ArcGIS/Runtime/Data/tpkx/san_diego").arg(defaultDataPath());
  if (!QFileInfo::exists(folderLocation))
  {
    qWarning() << "Please download required data.";
    return;
  }

  const QString fileLocation = folderLocation + QString("/streetmap_SD.tpkx");
  TileCache* tileCache = new TileCache(fileLocation, this);
  ArcGISTiledLayer* tiledLayer = new ArcGISTiledLayer(tileCache, this);
  Basemap* basemap = new Basemap(tiledLayer, this);
  m_map = new Map(basemap, this);
  m_map->setMinScale(100000);

  SimpleLineSymbol* lineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle::Solid, Qt::blue, 2, this);
  SimpleRenderer* routeRenderer = new SimpleRenderer(lineSymbol, this);
  m_routeOverlay->setRenderer(routeRenderer);

  m_pinSymbol->setHeight(50);
  m_pinSymbol->setWidth(50);
  m_pinSymbol->setOffsetY(m_pinSymbol->height() / 2);

  const QString geodatabaseLocation = folderLocation + QString("/sandiego.geodatabase");
  m_routeTask = new RouteTask(geodatabaseLocation, "Streets_ND", this);
  m_routeTask->load();
}

OfflineRouting::~OfflineRouting() = default;

void OfflineRouting::init()
{
  // Register the map view for QML
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<OfflineRouting>("Esri.Samples", 1, 0, "OfflineRoutingSample");
}

MapQuickView* OfflineRouting::mapView() const
{
  return m_mapView;
}

QStringList OfflineRouting::travelModeNames() const
{
  // if route task not initialized or loaded, then do not execute
  if (!m_routeTask)
  {
    return {};
  }

  if (m_routeTask->loadStatus() != LoadStatus::Loaded)
  {
    return {};
  }

  const QList<TravelMode> modesList = m_routeTask->routeTaskInfo().travelModes();
  QStringList strList;
  for (const TravelMode& mode : modesList)
  {
    strList << mode.name();
  }
  return strList;
}

void OfflineRouting::setTravelModeIndex(int index)
{
  if (m_travelModeIndex == index)
  {
    return;
  }

  m_travelModeIndex = index;
  emit travelModeIndexChanged();
}

int OfflineRouting::travelModeIndex() const
{
  return m_travelModeIndex;
}

void OfflineRouting::connectSignals()
{
  connect(m_routeTask, &RouteTask::doneLoading, this, [this](const Error& loadError)
  {
    if (loadError.isEmpty())
    {
      m_routeTask->createDefaultParametersAsync().then(this, [this](const RouteParameters& defaultParameters)
      {
        m_routeParameters = defaultParameters;
      });
      emit travelModeNamesChanged();
    }
    else
    {
      qDebug() << loadError.message() << loadError.additionalMessage();
    }
  });

  // check whether mouse pressed over an existing stop
  connect(m_mapView, &MapQuickView::mousePressed, this, [this](QMouseEvent& e)
  {
    m_mapView->identifyGraphicsOverlayAsync(m_stopsOverlay, e.position(), 10, false)
      .then(this, [this](IdentifyGraphicsOverlayResult* rawIdentifyResult)
    {
      auto result = std::unique_ptr<IdentifyGraphicsOverlayResult>(rawIdentifyResult);
      if (!result->error().isEmpty())
      {
        qDebug() << result->error().message() << result->error().additionalMessage();
      }

      m_selectedGraphic = nullptr;
      if (!result->graphics().isEmpty())
      {
        // identify selected graphic in m_stopsOverlay
        int index = m_stopsOverlay->graphics()->indexOf(result->graphics().at(0));
        m_selectedGraphic = m_stopsOverlay->graphics()->at(index);
      }
    });
  });

  // get stops from clicked locations
  connect(m_mapView, &MapQuickView::mouseClicked, this, [this](QMouseEvent& e)
  {
    if (!m_selectedGraphic)
    {
      // return if point is outside of bounds
      if (!GeometryEngine::within(m_mapView->screenToLocation(e.position().x(), e.position().y()), m_routableArea))
      {
        qWarning() << "Outside of routable area.";
        return;
      }
      TextSymbol* textSymbol = new TextSymbol(QString::number(m_stopsOverlay->graphics()->size() + 1), Qt::white, 20, HorizontalAlignment::Center,
                                              VerticalAlignment::Bottom, this);
      textSymbol->setOffsetY(m_pinSymbol->height() / 2);
      CompositeSymbol* stopLabel = new CompositeSymbol(QList<Symbol*>{m_pinSymbol, textSymbol}, this);
      Graphic* stopGraphic = new Graphic(m_mapView->screenToLocation(e.position().x(), e.position().y()), stopLabel, this);
      m_stopsOverlay->graphics()->append(stopGraphic);
      findRoute();
    }
    e.accept();
  });

  // mouseMoved is processed before identifyGraphicsOverlayCompleted, so must clear graphic upon mouseReleased
  connect(m_mapView, &MapQuickView::mouseReleased, this, [this](QMouseEvent& e)
  {
    if (m_selectedGraphic)
    {
      m_selectedGraphic = nullptr;
      e.accept();
    }
  });

  // if mouse is moved while pressing on a graphic, the click-and-pan effect of the MapView is prevented by e.accept()
  connect(m_mapView, &MapQuickView::mouseMoved, this, [this](QMouseEvent& e)
  {
    if (m_selectedGraphic)
    {
      e.accept();

      // return if point is outside of bounds
      if (!GeometryEngine::within(m_mapView->screenToLocation(e.position().x(), e.position().y()), m_routableArea))
      {
        qWarning() << "Outside of routable area.";
        return;
      }
      m_selectedGraphic->setGeometry(m_mapView->screenToLocation(e.position().x(), e.position().y()));
      findRoute();
    }
  });
}

void OfflineRouting::findRoute()
{
  if (!m_routeTaskFuture.isFinished() || m_stopsOverlay->graphics()->size() <= 1)
  {
    return;
  }

  QList<Stop> stops;
  for (const Graphic* graphic : *m_stopsOverlay->graphics())
  {
    stops << Stop(geometry_cast<Point>(graphic->geometry()));
  }

  // configure stops and travel mode
  m_routeParameters.setStops(stops);
  m_routeParameters.setTravelMode(m_routeTask->routeTaskInfo().travelModes().at(m_travelModeIndex));

  m_routeTaskFuture = m_routeTask->solveRouteAsync(m_routeParameters);
  m_routeTaskFuture.then(this, [this](const RouteResult& routeResult)
  {
    if (routeResult.isEmpty())
    {
      return;
    }

    // clear old route
    m_routeOverlay->graphics()->clear();
    Polyline routeGeometry = std::as_const(routeResult).routes().first().routeGeometry();
    Graphic* routeGraphic = new Graphic(routeGeometry, this);

    m_routeOverlay->graphics()->append(routeGraphic);
  });
}

// Set the view (created in QML)
void OfflineRouting::setMapView(MapQuickView* mapView)
{
  if (!mapView || mapView == m_mapView)
  {
    return;
  }

  m_mapView = mapView;
  m_mapView->setMap(m_map);

  m_mapView->graphicsOverlays()->append(m_stopsOverlay);
  m_mapView->graphicsOverlays()->append(m_routeOverlay);

  GraphicsOverlay* boundaryOverlay = new GraphicsOverlay(this);
  m_routableArea = Envelope(Point(-13045352.223196, 3864910.900750, SpatialReference::webMercator()),
                            Point(-13024588.857198, 3838880.505604, SpatialReference::webMercator()));
  SimpleLineSymbol* boundarySymbol = new SimpleLineSymbol(SimpleLineSymbolStyle::Dash, Qt::green, 3, this);
  Graphic* boundaryGraphic = new Graphic(m_routableArea, boundarySymbol, this);
  boundaryOverlay->graphics()->append(boundaryGraphic);
  m_mapView->graphicsOverlays()->append(boundaryOverlay);

  connectSignals();

  emit mapViewChanged();
}

void OfflineRouting::resetMap()
{
  m_selectedGraphic = nullptr;
  if (m_stopsOverlay)
  {
    m_stopsOverlay->graphics()->clear();
  }
  if (m_routeOverlay)
  {
    m_routeOverlay->graphics()->clear();
  }
}

// [WriteFile Name=OfflineRouting, Category=Routing]
// [Legal]
// Copyright 2020 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]

#ifndef OFFLINEROUTING_H
#define OFFLINEROUTING_H

// ArcGIS Maps SDK headers
#include "Envelope.h"
#include "RouteParameters.h"
#include "RouteResult.h"

// Qt headers
#include <QFuture>
#include <QObject>

namespace Esri::ArcGISRuntime
{
  class Graphic;
  class GraphicsOverlay;
  class Map;
  class MapQuickView;
  class PictureMarkerSymbol;
  class RouteTask;
} // namespace Esri::ArcGISRuntime

Q_MOC_INCLUDE("MapQuickView.h")

class OfflineRouting : public QObject
{
  Q_OBJECT

  Q_PROPERTY(Esri::ArcGISRuntime::MapQuickView* mapView READ mapView WRITE setMapView NOTIFY mapViewChanged)
  Q_PROPERTY(QStringList travelModeNames READ travelModeNames NOTIFY travelModeNamesChanged)
  Q_PROPERTY(int travelModeIndex READ travelModeIndex WRITE setTravelModeIndex NOTIFY travelModeIndexChanged)

public:
  explicit OfflineRouting(QObject* parent = nullptr);
  ~OfflineRouting();

  static void init();

  Q_INVOKABLE void findRoute();
  Q_INVOKABLE void resetMap();

  void connectSignals();

signals:
  void mapViewChanged();
  void travelModeNamesChanged();
  void travelModeIndexChanged();

private:
  Esri::ArcGISRuntime::MapQuickView* mapView() const;
  void setMapView(Esri::ArcGISRuntime::MapQuickView* mapView);

  QStringList travelModeNames() const;
  int travelModeIndex() const;
  void setTravelModeIndex(int index);

  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;

  Esri::ArcGISRuntime::PictureMarkerSymbol* m_pinSymbol = nullptr;
  Esri::ArcGISRuntime::Graphic* m_selectedGraphic = nullptr;
  Esri::ArcGISRuntime::GraphicsOverlay* m_stopsOverlay = nullptr;
  Esri::ArcGISRuntime::GraphicsOverlay* m_routeOverlay = nullptr;
  Esri::ArcGISRuntime::RouteTask* m_routeTask = nullptr;
  Esri::ArcGISRuntime::RouteParameters m_routeParameters;
  QFuture<Esri::ArcGISRuntime::RouteResult> m_routeTaskFuture;
  int m_travelModeIndex = -1;
  Esri::ArcGISRuntime::Envelope m_routableArea;
};

#endif // OFFLINEROUTING_H

// [WriteFile Name=OfflineRouting, Category=Routing]
// [Legal]
// Copyright 2020 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]

import QtQuick
import QtQuick.Controls
import Esri.Samples
import QtQuick.Layouts

Item {
    // add a mapView component
    MapView {
        id: view
        anchors.fill: parent

        Component.onCompleted: {
            // Set the focus on MapView to initially enable keyboard navigation
            forceActiveFocus();
        }
    }

    RowLayout {
        anchors {
            left: parent.left
            top: parent.top
        }

        ComboBox {
            id: comboBox
            Layout.fillWidth: true
            model: routingModel.travelModeNames
            onCurrentIndexChanged: {
                routingModel.travelModeIndex = currentIndex;
                routingModel.findRoute();
            }
        }

        Button {
            Layout.fillWidth: true
            Layout.fillHeight: true
            text: qsTr("Reset")
            onClicked: {
                routingModel.resetMap();
            }
        }
    }

    // Declare the C++ instance which creates the map etc. and supply the view
    OfflineRoutingSample {
        id: routingModel
        mapView: view
    }
}

// [Legal]
// Copyright 2020 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]

// sample headers
#include "OfflineRouting.h"

// ArcGIS Maps SDK headers
#include "ArcGISRuntimeEnvironment.h"

// Qt headers
#include <QDir>
#include <QGuiApplication>
#include <QQmlApplicationEngine>

// Platform specific headers
#ifdef Q_OS_WIN
#include <Windows.h>
#endif

int main(int argc, char* argv[])
{
  QGuiApplication app(argc, argv);
  app.setApplicationName(QString("OfflineRouting"));

  // Use of ArcGIS location services, such as basemap styles, geocoding, and routing services,
  // requires an access token. For more information see
  // https://links.esri.com/arcgis-runtime-security-auth.

  // The following methods grant an access token:

  // 1. User authentication: Grants a temporary access token associated with a user's ArcGIS account.
  // To generate a token, a user logs in to the app with an ArcGIS account that is part of an
  // organization in ArcGIS Online or ArcGIS Enterprise.

  // 2. API key authentication: Get a long-lived access token that gives your application access to
  // ArcGIS location services. Go to the tutorial at https://links.esri.com/create-an-api-key.
  // Copy the API Key access token.

  const QString accessToken = QString("");

  if (accessToken.isEmpty())
  {
    qWarning() << "Use of ArcGIS location services, such as the basemap styles service, requires"
               << "you to authenticate with an ArcGIS account or set the API Key property.";
  }
  else
  {
    Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setApiKey(accessToken);
  }

  // Initialize the sample
  OfflineRouting::init();

  // Initialize application view
  QQmlApplicationEngine engine;
  // Add the import Path
  engine.addImportPath(QDir(QCoreApplication::applicationDirPath()).filePath("qml"));

#ifdef ARCGIS_RUNTIME_IMPORT_PATH_2
  engine.addImportPath(ARCGIS_RUNTIME_IMPORT_PATH_2);
#endif

  // Set the source
  engine.load(QUrl("qrc:/Samples/Routing/OfflineRouting/main.qml"));

  return app.exec();
}

// Copyright 2020 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.

import QtQuick.Controls
import Esri.Samples

ApplicationWindow {
    visible: true
    width: 800
    height: 600

    OfflineRouting {
        anchors.fill: parent
    }
}