Identify KML features

// [WriteFile Name=IdentifyKmlFeatures, Category=Layers]
// [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 "IdentifyKmlFeatures.h"

// ArcGIS Maps SDK headers
#include "CalloutData.h"
#include "Envelope.h"
#include "IdentifyLayerResult.h"
#include "KmlDataset.h"
#include "KmlLayer.h"
#include "KmlPlacemark.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "SpatialReference.h"

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

using namespace Esri::ArcGISRuntime;

namespace
{
const QUrl datasetUrl("https://www.wpc.ncep.noaa.gov/kml/noaa_chart/WPC_Day1_SigWx_latest.kml");
}

IdentifyKmlFeatures::IdentifyKmlFeatures(QObject* parent /* = nullptr */):
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISDarkGray, this))
{
  // create new KML layer
  KmlDataset* forecastDataset = new KmlDataset(datasetUrl, this);
  m_forecastLayer = new KmlLayer(forecastDataset, this);
  m_map->operationalLayers()->append(m_forecastLayer);
}

IdentifyKmlFeatures::~IdentifyKmlFeatures() = default;

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

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

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

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

  // start zoomed in over the US
  m_mapView->setViewpointGeometryAsync(Envelope(-19195297.778679, 512343.939994, -3620418.579987, 8658913.035426, SpatialReference::webMercator()));

  // identify clicked features
  connect(m_mapView, &MapQuickView::mouseClicked, this, [this](QMouseEvent& e)
  {
    m_clickedPoint = m_mapView->screenToLocation(e.position().x(), e.position().y());
    m_mapView->identifyLayerAsync(m_forecastLayer, e.position(), 15, false)
        .then(this, [this](IdentifyLayerResult* rawResult)
    {
      auto result = std::unique_ptr<IdentifyLayerResult>(rawResult);

      // if not clicked on KML feature then close callout
      if (result->geoElements().length() < 1)
      {
        m_mapView->calloutData()->setVisible(false);
        return;
      }

      // find the first geoElement that is a KML placemark
      const auto elements = result->geoElements();
      for (GeoElement* geoElement : elements)
      {
        if (KmlPlacemark* placemark = dynamic_cast<KmlPlacemark*>(geoElement))
        {
          // Google Earth only displays the placemarks with description or extended data. To
          // match its behavior, add a description placeholder if the data source is empty
          if (placemark->description().isEmpty())
            placemark->setDescription("Weather condition");

          m_calloutText = placemark->balloonContent();
          m_mapView->calloutData()->setLocation(m_clickedPoint);
          m_mapView->calloutData()->setVisible(true);

          emit calloutDataChanged();
          emit calloutTextChanged();
          return;
        }
      }
    });
  });

  emit mapViewChanged();
}

CalloutData* IdentifyKmlFeatures::calloutData() const
{
  return m_calloutData;
}

QString IdentifyKmlFeatures::calloutText() const
{
  return m_calloutText;
}

// [WriteFile Name=IdentifyKmlFeatures, Category=Layers]
// [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 IDENTIFYKMLFEATURES_H
#define IDENTIFYKMLFEATURES_H

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

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

namespace Esri::ArcGISRuntime
{
class CalloutData;
class KmlLayer;
class Map;
class MapQuickView;
}

Q_MOC_INCLUDE("MapQuickView.h")
Q_MOC_INCLUDE("CalloutData.h")

class IdentifyKmlFeatures : public QObject
{
  Q_OBJECT

  Q_PROPERTY(Esri::ArcGISRuntime::MapQuickView* mapView READ mapView WRITE setMapView NOTIFY mapViewChanged)
  Q_PROPERTY(Esri::ArcGISRuntime::CalloutData* calloutData READ calloutData NOTIFY calloutDataChanged)
  Q_PROPERTY(QString calloutText READ calloutText NOTIFY calloutTextChanged)

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

  static void init();

signals:
  void mapViewChanged();
  void calloutDataChanged();
  void calloutTextChanged();

private:
  Esri::ArcGISRuntime::MapQuickView* mapView() const;
  void setMapView(Esri::ArcGISRuntime::MapQuickView* mapView);
  Esri::ArcGISRuntime::CalloutData* calloutData() const;
  QString calloutText() const;

  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;
  Esri::ArcGISRuntime::CalloutData* m_calloutData = nullptr;
  Esri::ArcGISRuntime::KmlLayer* m_forecastLayer = nullptr;
  Esri::ArcGISRuntime::Point m_clickedPoint;
  QString m_calloutText;
};

#endif // IDENTIFYKMLFEATURES_H

// [WriteFile Name=IdentifyKmlFeatures, Category=Layers]
// [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 Esri.ArcGISRuntime.Toolkit

Item {

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

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

        Callout {
            id: callout
            calloutData: view.calloutData
            implicitWidth: 150
            implicitHeight: contentText.implicitHeight + (contentText.implicitHeight * .05)
            contentItem: Label {
                id: contentText
                text: model.calloutText
                wrapMode: Text.WordWrap
                textFormat: Text.RichText
                horizontalAlignment: Qt.AlignHCenter
                verticalAlignment: Qt.AlignVCenter
            }
        }
    }

    // Declare the C++ instance which creates the map etc. and supply the view
    IdentifyKmlFeaturesSample {
        id: model
        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 "IdentifyKmlFeatures.h"

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

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

// Other headers
#include "Esri/ArcGISRuntime/Toolkit/register.h"

// 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("IdentifyKmlFeatures"));

  // 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
  IdentifyKmlFeatures::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

  Esri::ArcGISRuntime::Toolkit::registerComponents(engine);

  // Set the source
  engine.load(QUrl("qrc:/Samples/Layers/IdentifyKmlFeatures/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

    IdentifyKmlFeatures {
        anchors.fill: parent
    }
}