Display route layer

// [WriteFile Name=DisplayRouteLayer, Category=Routing]
// [Legal]
// Copyright 2022 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 "DisplayRouteLayer.h"

// ArcGIS Maps SDK headers
#include "ArcGISFeature.h"
#include "AttributeListModel.h"
#include "Error.h"
#include "Feature.h"
#include "FeatureCollection.h"
#include "FeatureCollectionLayer.h"
#include "FeatureCollectionTable.h"
#include "FeatureCollectionTableListModel.h"
#include "FeatureIterator.h"
#include "FeatureQueryResult.h"
#include "FeatureTable.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "Point.h"
#include "Portal.h"
#include "PortalItem.h"
#include "PortalTypes.h"
#include "QueryParameters.h"
#include "SpatialReference.h"

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

using namespace Esri::ArcGISRuntime;
namespace
{
static const QString featureCollectionItemId("0e3c8e86b4544274b45ecb61c9f41336");
}

DisplayRouteLayer::DisplayRouteLayer(QObject* parent /* = nullptr */):
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISTopographic, this))
{
  Portal* portal = new Portal(this);
  m_portalItem = new PortalItem(portal, featureCollectionItemId, this);

  connect(m_portalItem, &PortalItem::doneLoading, this, [this](const Error& loadError)
  {
    if (!loadError.isEmpty())
    {
      qWarning() << loadError.message() << loadError.additionalMessage();
      return;
    }

    // if the portal item is a feature collection, add the feature collection to the map's operational layers
    if (m_portalItem->type() == PortalItemType::FeatureCollection)
    {
      m_featureCollection = new FeatureCollection(m_portalItem, this);
      m_featureCollectionLayer = new FeatureCollectionLayer(m_featureCollection, this);

      connect(m_featureCollectionLayer, &FeatureCollectionLayer::doneLoading, this, [this](const Error& e)
      {
        if (!e.isEmpty())
          return;

        getDirections();
        emit enableDirectionsButton();
      });

      m_map->operationalLayers()->append(m_featureCollectionLayer);
    }
    else
    {
      qWarning() << "Portal item with ID " << featureCollectionItemId << " is not a feature collection.";
    }
  });

  m_portalItem->load();
}

DisplayRouteLayer::~DisplayRouteLayer() = default;

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

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

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

  m_mapView = mapView;
  m_mapView->setMap(m_map);
  const Point vpCenter(-122.8309, 45.2281, SpatialReference(4326));
  m_mapView->setViewpointCenterAsync(vpCenter, 800000);

  emit mapViewChanged();
}

void DisplayRouteLayer::getDirections()
{
  if (!m_featureCollectionLayer)
    return;

  FeatureCollectionTableListModel* tables = m_featureCollection->tables();
  for (FeatureTable* table : *tables)
  {
    if (table->loadStatus() == LoadStatus::Loaded)
    {
      if (table->tableName() == "DirectionPoints")
      {
        QueryParameters queryParams;
        queryParams.setWhereClause("1=1");
        table->queryFeaturesAsync(queryParams).then(this, [this](const FeatureQueryResult* featureQueryResult)
        {
          if (!featureQueryResult)
            return;
          // Clear the directions list before repopulating it
          m_featureDirection.clear();

          while (featureQueryResult && featureQueryResult->iterator().hasNext())
          {
            m_feature = static_cast<ArcGISFeature*>(featureQueryResult->iterator().next(this));
            m_featureDirection = m_featureDirection + "\n - " + m_feature->attributes()->attributeValue(QStringLiteral("DisplayText")).toString();
            emit directionsChanged();
          }
        });
      }
    }
  }
}

QString DisplayRouteLayer::directions() const
{
  return m_featureDirection;
}

// [WriteFile Name=DisplayRouteLayer, Category=Routing]
// [Legal]
// Copyright 2022 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 DISPLAYROUTELAYER_H
#define DISPLAYROUTELAYER_H

// Qt headers
#include <QObject>

// STL headers
#include <FeatureCollectionTableListModel.h>

namespace Esri
{
namespace ArcGISRuntime
{
class Feature;
class FeatureCollection;
class FeatureCollectionLayer;
class FeatureCollectionTableListModel;
class FeatureTable;
class Map;
class MapQuickView;
class PortalItem;
}
}

Q_MOC_INCLUDE("MapQuickView.h")

class DisplayRouteLayer : public QObject
{
  Q_OBJECT

  Q_PROPERTY(Esri::ArcGISRuntime::MapQuickView* mapView READ mapView WRITE setMapView NOTIFY mapViewChanged)
  Q_PROPERTY(QString directions READ directions NOTIFY directionsChanged)

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

  static void init();
  Q_INVOKABLE void getDirections();

signals:
  void mapViewChanged();
  void directionsChanged();
  void enableDirectionsButton();

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

  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;
  Esri::ArcGISRuntime::PortalItem* m_portalItem = nullptr;
  Esri::ArcGISRuntime::FeatureCollection* m_featureCollection = nullptr;
  Esri::ArcGISRuntime::FeatureCollectionLayer* m_featureCollectionLayer = nullptr;
  Esri::ArcGISRuntime::Feature* m_feature = nullptr;
  QString m_featureDirection = "";
};

#endif // DISPLAYROUTELAYER_H

// [WriteFile Name=DisplayRouteLayer, Category=Routing]
// [Legal]
// Copyright 2022 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 as Controls
import Esri.Samples
import QtQuick.Layouts

Item {

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

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

        Controls.Button {
            id: directionsButton
            anchors {
                bottom: parent.bottom
                horizontalCenter: parent.horizontalCenter
                margins: 40
            }
            text: "Directions"
            enabled: false
            onClicked: popup.open();
        }

        Controls.Popup {
            id: popup
            anchors.centerIn: Controls.Overlay.overlay
            width: 300
            height: 320
            focus: true
            contentItem: Controls.ScrollView {
                contentWidth: parent.width - 30
                Text {
                    width: parent.width
                    text: model.directions
                    wrapMode: Text.WordWrap
                }
                clip: true
            }
            opacity: .9
        }
    }

    // Declare the C++ instance which creates the map etc. and supply the view
    DisplayRouteLayerSample {
        id: model
        mapView: view

        onEnableDirectionsButton: {
            directionsButton.enabled = true;
        }
    }
}

// [Legal]
// Copyright 2022 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 "DisplayRouteLayer.h"

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

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

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

int main(int argc, char *argv[])
{
  Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setUseLegacyAuthentication(false);
  QGuiApplication app(argc, argv);
  app.setApplicationName(QString("DisplayRouteLayer"));

  // 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
  DisplayRouteLayer::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/DisplayRouteLayer/main.qml"));

  return app.exec();
}

// Copyright 2022 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

    DisplayRouteLayer {
        anchors.fill: parent
    }
}