Get elevation at point

// [WriteFile Name=GetElevationAtPoint, Category=Scenes]
// [Legal]
// Copyright 2019 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 "GetElevationAtPoint.h"

// ArcGIS Maps SDK headers
#include "ArcGISTiledElevationSource.h"
#include "Camera.h"
#include "ElevationSourceListModel.h"
#include "Graphic.h"
#include "GraphicListModel.h"
#include "GraphicsOverlay.h"
#include "GraphicsOverlayListModel.h"
#include "MapTypes.h"
#include "Point.h"
#include "Scene.h"
#include "SceneQuickView.h"
#include "SimpleMarkerSymbol.h"
#include "Surface.h"
#include "SymbolTypes.h"

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

using namespace Esri::ArcGISRuntime;

GetElevationAtPoint::GetElevationAtPoint(QObject* parent /* = nullptr */) :
  QObject(parent),
  m_scene(new Scene(BasemapStyle::ArcGISImageryStandard, this)),
  m_graphicsOverlay(new GraphicsOverlay(this)),
  m_elevationMarker(new Graphic(Geometry(), new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::Circle, QColor("red"), 12, this), this))
{
  // create a new elevation source from Terrain3D REST service
  ArcGISTiledElevationSource* elevationSource =
    new ArcGISTiledElevationSource(QUrl("https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"), this);

  // add the elevation source to the scene to display elevation
  m_scene->baseSurface()->elevationSources()->append(elevationSource);

  // Set the marker to be invisible initially, will be flaggd visible when user interacts with scene for the first time, to visualise clicked position
  m_elevationMarker->setVisible(false);

  // Add the marker to the graphics overlay so it will be displayed. Graphics overlay is attached to the sceneView in ::setSceneView()
  m_graphicsOverlay->graphics()->append(m_elevationMarker);
}

GetElevationAtPoint::~GetElevationAtPoint() = default;

void GetElevationAtPoint::init()
{
  // Register classes for QML
  qmlRegisterType<SceneQuickView>("Esri.Samples", 1, 0, "SceneView");
  qmlRegisterType<GetElevationAtPoint>("Esri.Samples", 1, 0, "GetElevationAtPointSample");
}

SceneQuickView* GetElevationAtPoint::sceneView() const
{
  return m_sceneView;
}

// Set the view (created in QML)
void GetElevationAtPoint::setSceneView(SceneQuickView* sceneView)
{
  if (!sceneView || sceneView == m_sceneView)
  {
    return;
  }

  m_sceneView = sceneView;
  m_sceneView->setArcGISScene(m_scene);

  // Create a camera, looking at the Himalayan mountain range.
  constexpr double latitude = 28.4;
  constexpr double longitude = 83.9;
  constexpr double altitude = 10000.0;
  constexpr double heading = 10.0;
  constexpr double pitch = 80.0;
  constexpr double roll = 0.0;
  Camera camera(latitude, longitude, altitude, heading, pitch, roll);

  // Set the sceneview to use above camera, waits for load so scene is immediately displayed in appropriate place.
  m_sceneView->setViewpointCameraAndWait(camera);

  // Append the graphics overlays to the sceneview, so we can visualise elevation on click
  m_sceneView->graphicsOverlays()->append(m_graphicsOverlay);

  // Hook up clicks into the 3d scene to below behaviour that displays marker & elevation value.
  connect(sceneView, &SceneQuickView::mouseClicked, this, &GetElevationAtPoint::displayElevationOnClick);

  emit sceneViewChanged();
}

void GetElevationAtPoint::displayElevationOnClick(QMouseEvent& mouseEvent)
{
  // Convert clicked screen position to position on the map surface.
  const Point baseSurfacePos = m_sceneView->screenToBaseSurface(mouseEvent.position().x(), mouseEvent.position().y());

  m_elevationQueryFuture = m_scene->baseSurface()->elevationAsync(baseSurfacePos);
  m_elevationQueryFuture.then(this, [this, baseSurfacePos](double elevation)
  {
    // Place the elevation marker circle at the clicked position
    m_elevationMarker->setGeometry(baseSurfacePos);
    m_elevationMarker->setVisible(true);

    // Assign the elevation value. UI is bound to this value, so it updates to display new elevation.
    m_elevation = elevation;

    // Notify of property changes
    emit elevationChanged(elevation);
    emit elevationQueryRunningChanged();
  });

  //Signal the start of the query
  emit elevationQueryRunningChanged();
}

double GetElevationAtPoint::elevation() const
{
  return m_elevation;
}

bool GetElevationAtPoint::elevationQueryRunning() const
{
  return m_elevationQueryFuture.isRunning();
}

// [WriteFile Name=GetElevationAtPoint, Category=Scenes]
// [Legal]
// Copyright 2019 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 GETELEVATIONATPOINT_H
#define GETELEVATIONATPOINT_H

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

namespace Esri::ArcGISRuntime
{
  class Graphic;
  class GraphicsOverlay;
  class Scene;
  class SceneQuickView;
} // namespace Esri::ArcGISRuntime

class QMouseEvent;

Q_MOC_INCLUDE("SceneQuickView.h")

class GetElevationAtPoint : public QObject
{
  Q_OBJECT

  Q_PROPERTY(Esri::ArcGISRuntime::SceneQuickView* sceneView READ sceneView WRITE setSceneView NOTIFY sceneViewChanged)
  Q_PROPERTY(double elevation READ elevation NOTIFY elevationChanged)
  Q_PROPERTY(bool elevationQueryRunning READ elevationQueryRunning NOTIFY elevationQueryRunningChanged)

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

  static void init();

private slots:
  void displayElevationOnClick(QMouseEvent& mouseEvent);

signals:
  void sceneViewChanged();
  void elevationChanged(double newElevation);
  void elevationQueryRunningChanged();

private:
  Esri::ArcGISRuntime::SceneQuickView* sceneView() const;
  void setSceneView(Esri::ArcGISRuntime::SceneQuickView* sceneView);

  Esri::ArcGISRuntime::Scene* m_scene = nullptr;
  Esri::ArcGISRuntime::SceneQuickView* m_sceneView = nullptr;

  Esri::ArcGISRuntime::GraphicsOverlay* m_graphicsOverlay = nullptr;
  Esri::ArcGISRuntime::Graphic* m_elevationMarker = nullptr;

  //Property exposing elevation to the QML UI.
  double elevation() const;
  //Property exposing whether the elevation query is running to the QML UI, so the busy indicator can be displayed
  bool elevationQueryRunning() const;

  double m_elevation = 0.0;
  QFuture<double> m_elevationQueryFuture;
};

#endif // GETELEVATIONATPOINT_H

// [WriteFile Name=GetElevationAtPoint, Category=Scenes]
// [Legal]
// Copyright 2019 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 Esri.Samples
import QtQuick
import QtQuick.Controls

Item {

    SceneView {
        id: view
        anchors.fill: parent

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

    // Declare the C++ instance which creates the scene etc. and supply the view
    GetElevationAtPointSample {
        id: model
        sceneView: view
    }

    // Background rectangle for elevation display
    Rectangle {
        anchors {
            bottom: parent.bottom
            left: parent.left
            right: parent.right
            margins: 30
        }

        color: palette.base
        height: childrenRect.height

        // Elevation display text
        Label {
            anchors {
                horizontalCenter: parent.horizontalCenter
            }
            padding: 15
            font.pointSize: 16

            // For vertical screens, keep the text within the bounding box via scaling down.
            scale: Math.min(1, (parent.width - padding) / contentWidth)

            // Display elevation value in meters, round to a single decimal place.
            text: qsTr("Elevation : " + Math.round(model.elevation * 10) / 10 + "m")
        }
    }

    // Display an indictor when the elevation query is running, since it might take a couple of seconds
    BusyIndicator {
        running: model.elevationQueryRunning
        anchors.centerIn: parent
        width: Math.min(parent.width, parent.height) / 6.0
        height: width
        visible: model.elevationQueryRunning
    }

}

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

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

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

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

#define STRINGIZE(x) #x
#define QUOTE(x) STRINGIZE(x)

int main(int argc, char* argv[])
{
#if defined(Q_OS_LINUX) && !defined(Q_OS_ANDROID)
  // Linux requires 3.2 OpenGL Context
  // in order to instance 3D symbols
  QSurfaceFormat fmt = QSurfaceFormat::defaultFormat();
  fmt.setVersion(3, 2);
  QSurfaceFormat::setDefaultFormat(fmt);
#endif

  QGuiApplication app(argc, argv);
  app.setApplicationName(QString("GetElevationAtPoint"));

  // 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
  GetElevationAtPoint::init();

  QString arcGISRuntimeImportPath = QUOTE(ARCGIS_RUNTIME_IMPORT_PATH);

#if defined(LINUX_PLATFORM_REPLACEMENT)
  // on some linux platforms the string 'linux' is replaced with 1
  // fix the replacement paths which were created
  QString replaceString = QUOTE(LINUX_PLATFORM_REPLACEMENT);
  arcGISRuntimeImportPath = arcGISRuntimeImportPath.replace(replaceString, "linux", Qt::CaseSensitive);
#endif

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

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

  return app.exec();
}

// Copyright 2018 ESRI
//
// All rights reserved under the copyright laws of the United States
// and applicable international laws, treaties, and conventions.
//
// You may freely redistribute and use this sample code, with or
// without modification, provided you include the original copyright
// notice and use restrictions.
//
// See the Sample code usage restrictions document for further information.
//

import QtQuick.Controls
import Esri.Samples

ApplicationWindow {
    visible: true
    width: 800
    height: 600

    GetElevationAtPoint {
        anchors.fill: parent
    }
}