List transformations by suitability

// [WriteFile Name=ListTransformations, Category=Geometry]
// [Legal]
// Copyright 2017 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 "ListTransformations.h"

// ArcGIS Maps SDK headers
#include "DatumTransformation.h"
#include "Envelope.h"
#include "Error.h"
#include "GeographicTransformation.h"
#include "GeographicTransformationStep.h"
#include "GeometryEngine.h"
#include "Graphic.h"
#include "GraphicListModel.h"
#include "GraphicsOverlay.h"
#include "GraphicsOverlayListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "Point.h"
#include "Polygon.h"
#include "SimpleMarkerSymbol.h"
#include "SpatialReference.h"
#include "SymbolTypes.h"
#include "TransformationCatalog.h"
#include "Viewpoint.h"

// Qt headers
#include <QStandardPaths>
#include <QUrl>
#include <QVariantMap>
#include <QtCore/qglobal.h>

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;
  }
} // namespace

ListTransformations::ListTransformations(QQuickItem* parent /* = nullptr */):
  QQuickItem(parent)
{
}

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

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

  // get data path
  const QUrl dataPath = QUrl(defaultDataPath() + "/ArcGIS/Runtime/Data/PEDataRuntime");

  // connect to TransformationCatalog error signal
  connect(TransformationCatalog::instance(), &TransformationCatalog::errorOccurred, this, [this](const Error& e)
  {
    if (e.isEmpty())
      return;

    emit showStatusBar(QString("Error setting projection engine directory: %1. %2").arg(e.message(), e.additionalMessage()));
  });

  // Create a geometry located in the Greenwich observatory courtyard in London, UK, the location of the
  // Greenwich prime meridian. This will be projected using the selected transformation.
  const double x = 538985.355;
  const double y = 177329.516;
  m_originalPoint = Point(x, y, SpatialReference(27700));

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

  // Create a map using the light gray canvas basemap
  m_map = new Map(BasemapStyle::ArcGISLightGray, this);

  // Set initial viewpoint of the map
  m_map->setInitialViewpoint(Viewpoint(m_originalPoint, 5000));

  // connect to map loaded signal
  connect(m_map, &Map::doneLoading, this, [this, dataPath]
  {
    // Set the TransformationCatalog path
    TransformationCatalog::setProjectionEngineDirectory(dataPath.toString());
    if (TransformationCatalog::projectionEngineDirectory().length() > 0)
      emit showStatusBar(QString("Projection engine directory set: %1").arg(TransformationCatalog::instance()->projectionEngineDirectory()));

    // get the initial list of transformations
    refreshTransformationList(true);
  });

  // add graphics to the map view
  addGraphics();

  // set map to map view
  m_mapView->setMap(m_map);
}

// Create a GraphicsOverlay with two Graphics - one to hold the default
// transformed geometry, and the other to use the selected transformation
void ListTransformations::addGraphics()
{
  // Create the original graphic
  SimpleMarkerSymbol* blueSquare = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::Square, QColor("blue"), 20.f, this);
  m_originalGraphic = new Graphic(m_originalPoint, blueSquare, this);

  // Create the projected graphic
  SimpleMarkerSymbol* redCross = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::Cross, QColor("red"), 20.f, this);
  m_projectedGraphic = new Graphic(m_originalPoint, redCross, this);

  // Create the Overlay
  GraphicsOverlay* overlay = new GraphicsOverlay(this);
  m_mapView->graphicsOverlays()->append(overlay);
  overlay->graphics()->append(m_originalGraphic);
  overlay->graphics()->append(m_projectedGraphic);
}

void ListTransformations::refreshTransformationList(bool orderBySuitability)
{
  // get the input/output spatial reference
  SpatialReference inSpatialReference = m_originalGraphic->geometry().spatialReference();
  SpatialReference outSpatialReference = m_map->spatialReference();

  // request the transformations
  if (orderBySuitability)
    m_transformations = TransformationCatalog::transformationsBySuitability(inSpatialReference, outSpatialReference, m_mapView->visibleArea().extent());
  else
    m_transformations = TransformationCatalog::transformationsBySuitability(inSpatialReference, outSpatialReference);

  // update the QML property list
  m_transformationList.clear();
  for (DatumTransformation* transformation : std::as_const(m_transformations))
  {
    QVariantMap transformationMap;
    transformationMap["name"] = transformation->name();
    transformationMap["isMissingProjectionEngineFiles"] = transformation->isMissingProjectionEngineFiles();
    m_transformationList.append(transformationMap);
  }

  // update the property
  emit transformationListChanged();
}

void ListTransformations::updateGraphicTransformation(int index)
{
  GeographicTransformation* transform = static_cast<GeographicTransformation*>(m_transformations.at(index));
  if (transform->isMissingProjectionEngineFiles())
  {
    QString missingFiles = "Missing grid files: ";
    const QList<GeographicTransformationStep> steps = transform->steps();
    for (const GeographicTransformationStep& step : steps)
    {
      const auto filenames = step.projectionEngineFilenames();
      for (const QString& filename : filenames)
      {
        missingFiles += filename;
      }
    }
    emit showStatusBar(missingFiles);
  }
  else
  {
    Geometry projectedPoint = GeometryEngine::project(m_originalPoint, m_map->spatialReference(), transform);
    m_projectedGraphic->setGeometry(projectedPoint);
  }
}

// [WriteFile Name=ListTransformations, Category=Geometry]
// [Legal]
// Copyright 2017 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 LISTTRANSFORMATIONS_H
#define LISTTRANSFORMATIONS_H

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

// Qt headers
#include <QList>
#include <QQuickItem>
#include <QVariantList>

namespace Esri::ArcGISRuntime
{
class Map;
class MapQuickView;
class Graphic;
class DatumTransformation;
}

class ListTransformations : public QQuickItem
{
  Q_OBJECT

  Q_PROPERTY(QVariantList transformationList MEMBER m_transformationList NOTIFY transformationListChanged)

public:
  explicit ListTransformations(QQuickItem* parent = nullptr);
  ~ListTransformations() override = default;

  void componentComplete() override;
  static void init();
  Q_INVOKABLE void refreshTransformationList(bool orderBySuitability);
  Q_INVOKABLE void updateGraphicTransformation(int index);

signals:
  void transformationListChanged();
  void showStatusBar(QString message = "");

private:
  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;
  Esri::ArcGISRuntime::Point m_originalPoint;
  Esri::ArcGISRuntime::Graphic* m_originalGraphic = nullptr;
  Esri::ArcGISRuntime::Graphic* m_projectedGraphic = nullptr;
  QList<Esri::ArcGISRuntime::DatumTransformation*> m_transformations;
  QVariantList m_transformationList;

  void addGraphics();
};

#endif // LISTTRANSFORMATIONS_H

// [WriteFile Name=ListTransformations, Category=Geometry]
// [Legal]
// Copyright 2017 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

ListTransformationsSample {
    id: rootRectangle
    clip: true
    width: 800
    height: 600

    // add a mapView component
    MapView {
        id: mapView
        anchors {
            left: parent.left
            right: parent.right
            top: parent.top
        }
        height: parent.height / 2
        objectName: "mapView"

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

    Rectangle {
        id: transformationView

        anchors {
            left: parent.left
            right: parent.right
            top: mapView.bottom
        }

        height: parent.height / 2
        color: "#f7f7f7"

        CheckBox {
            id: orderCheckbox
            anchors {
                left: parent.left
                top: parent.top
                margins: 10
            }
            text: "Order by suitability for map extent"
            onCheckedChanged: refreshTransformationList(checked);
        }

        ListView {
            id: transformationListView
            anchors {
                left: parent.left
                right: parent.right
                top: orderCheckbox.bottom
                bottom: parent.bottom
                margins: 10
            }
            clip: true
            model: transformationList

            delegate: Item {
                id: itemDelegate
                height: 45
                width: transformationListView.width
                clip: true

                // show the DatumTransformation name
                Text {
                    id: label
                    anchors {
                        verticalCenter: parent.verticalCenter
                        left: parent.left
                        right: parent.right
                    }
                    width: parent.width
                    text: model.modelData.isMissingProjectionEngineFiles ? "%1 <font color=red><b>Missing grid files</b></font>".arg(model.modelData.name) : model.modelData.name
                    textFormat: Text.RichText
                    wrapMode: Text.WrapAnywhere
                    maximumLineCount: 2
                    font.pixelSize: 12
                }

                MouseArea {
                    id: itemMouseArea
                    anchors.fill: parent
                    onClicked: {
                        transformationListView.currentIndex = index;
                        updateGraphicTransformation(index);
                    }
                }
            }

            highlightMoveDuration: 1
            highlightFollowsCurrentItem: true
            highlight: Rectangle {
                color: "#d6d6d6"
                radius: 4
            }
        }
    }

    Rectangle {
        id: statusBar
        property int expanded: parent.height - height
        property int hidden: parent.height
        property bool isExpanded: y === expanded
        anchors {
            left: parent.left
            right: parent.right
        }
        height: 45
        color: "black"
        y: hidden

        Text {
            id: statusText
            anchors {
                left: parent.left
                right: parent.right
                verticalCenter: parent.verticalCenter
                margins: 10
            }
            color: "white"
            wrapMode: Text.WrapAnywhere
        }

        Timer {
            id: timer
            interval: 5000
            onTriggered: statusBar.animate();
        }

        onYChanged: {
            if (y === expanded)
                timer.restart();
        }

        NumberAnimation {
            id: statusAnimation
            target: statusBar
            properties: "y"
            duration: 500
            easing.type: Easing.OutQuad
        }

        function expand() {
            statusAnimation.from = statusBar.hidden;
            statusAnimation.to = statusBar.expanded;
            statusAnimation.start();
        }

        function hide() {
            statusAnimation.from = statusBar.expanded;
            statusAnimation.to = statusBar.hidden;
            statusAnimation.start();
        }

        function animate() {
            if (statusBar.y === statusBar.hidden)
                expand();
            else
                hide();
        }
    }

    onShowStatusBar: message => {
        statusText.text = message;

        if (statusBar.isExpanded)
            timer.restart();
        else
            statusBar.expand();
    }
}

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

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

// Qt headers
#include <QCommandLineParser>
#include <QDir>
#include <QGuiApplication>
#include <QQmlEngine>
#include <QQuickView>

// 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[])
{
  Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setUseLegacyAuthentication(false);
  QGuiApplication app(argc, argv);
  app.setApplicationName(QString("ListTransformations"));

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

  // Initialize application view
  QQuickView view;
  view.setResizeMode(QQuickView::SizeRootObjectToView);

  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

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

  // Set the source
  view.setSource(QUrl("qrc:/Samples/Geometry/ListTransformations/ListTransformations.qml"));

  view.show();

  return app.exec();
}