Buffer

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

// ArcGIS Maps SDK headers
#include "GeometryEngine.h"
#include "Graphic.h"
#include "GraphicListModel.h"
#include "GraphicsOverlay.h"
#include "GraphicsOverlayListModel.h"
#include "LinearUnit.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "Point.h"
#include "Polygon.h"
#include "SimpleFillSymbol.h"
#include "SimpleLineSymbol.h"
#include "SimpleMarkerSymbol.h"
#include "SimpleRenderer.h"
#include "SymbolTypes.h"

// STL headers
#include <cmath>

using namespace Esri::ArcGISRuntime;

Buffer::Buffer(QObject* parent /* = nullptr */) :
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISTopographic, this))
{
}

Buffer::~Buffer() = default;

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

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

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

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

  // add a graphics overlay for the geodesic buffer
  m_graphicsOverlayGeodesic = new GraphicsOverlay(this);
  m_mapView->graphicsOverlays()->append(m_graphicsOverlayGeodesic);

  // add a graphics overlay for the planar buffer
  m_graphicsOverlayPlanar = new GraphicsOverlay(this);
  m_mapView->graphicsOverlays()->append(m_graphicsOverlayPlanar);

  // add a graphics overlay for the mouse click
  m_graphicsOverlayPoints = new GraphicsOverlay(this);
  m_mapView->graphicsOverlays()->append(m_graphicsOverlayPoints);

  // create symbol for the geodesic buffer result
  SimpleLineSymbol* outlineGeodesic = new SimpleLineSymbol(SimpleLineSymbolStyle::Solid, QColor("red"), 2.0f /*width*/, this);
  SimpleFillSymbol* sfsGeodesic = new SimpleFillSymbol(SimpleFillSymbolStyle::Solid, QColor(255, 0, 0, 122), outlineGeodesic, this);
  m_graphicsOverlayGeodesic->setRenderer(new SimpleRenderer(sfsGeodesic, this));

  // create symbol for the planar buffer result
  SimpleLineSymbol* outlinePlanar = new SimpleLineSymbol(SimpleLineSymbolStyle::Solid, QColor("blue"), 2.0f /*width*/, this);
  SimpleFillSymbol* sfsPlanar = new SimpleFillSymbol(SimpleFillSymbolStyle::Solid, QColor(0, 0, 255, 122), outlinePlanar, this);
  m_graphicsOverlayPlanar->setRenderer(new SimpleRenderer(sfsPlanar, this));

  // create symbol for the mouse click
  SimpleMarkerSymbol* sms = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::Cross, QColor("white"), 14.0f /*width*/, this);
  m_graphicsOverlayPoints->setRenderer(new SimpleRenderer(sms, this));

  // connect to mouse clicked signal
  connect(m_mapView, &MapQuickView::mouseClicked, this, &Buffer::onMouseClicked);

  emit mapViewChanged();
}

// handle the mouse click - perform a buffer on click
void Buffer::onMouseClicked(QMouseEvent& mouse)
{
  // get the map point from the mouse click
  const Point point = m_mapView->screenToLocation(mouse.position().x(), mouse.position().y());

  // Create a variable to be the buffer size in meters. There are 1609.34 meters in one mile.
  const int bufferInMeters = bufferSize() * 1609.34;

  // Create a planar buffer graphic around the input location at the specified distance.
  const Geometry buffer = GeometryEngine::buffer(point, bufferInMeters);

  // Add the result planar buffer as a graphic
  Graphic* resultGraphicPlanar = new Graphic(buffer, this);
  m_graphicsOverlayPlanar->graphics()->append(resultGraphicPlanar);

  // Create a geodesic buffer graphic around the input location at the specified distance.
  const Geometry bufferGeodesic =
    GeometryEngine::bufferGeodetic(point, bufferInMeters, LinearUnit(LinearUnitId::Meters), NAN, GeodeticCurveType::Geodesic);

  // Add the result geodesic buffer as a graphic
  Graphic* resultGraphicGeodesic = new Graphic(bufferGeodesic, this);
  m_graphicsOverlayGeodesic->graphics()->append(resultGraphicGeodesic);

  // Add the clicked point as a graphic
  Graphic* clickedPointGraphic = new Graphic(point, this);
  m_graphicsOverlayPoints->graphics()->append(clickedPointGraphic);
}

int Buffer::bufferSize() const
{
  return m_bufferSize;
}

void Buffer::setBufferSize(int size)
{
  if (size == m_bufferSize)
  {
    return;
  }

  m_bufferSize = size;
}

void Buffer::clear()
{
  m_graphicsOverlayGeodesic->graphics()->clear();
  m_graphicsOverlayPlanar->graphics()->clear();
  m_graphicsOverlayPoints->graphics()->clear();
}

// [WriteFile Name=Buffer, Category=Geometry]
// [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 BUFFER_H
#define BUFFER_H

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

namespace Esri::ArcGISRuntime
{
  class GraphicsOverlay;
  class Map;
  class MapQuickView;
  class SimpleMarkerSymbol;
  class SimpleFillSymbol;
} // namespace Esri::ArcGISRuntime

Q_MOC_INCLUDE("MapQuickView.h");

class Buffer : public QObject
{
  Q_OBJECT

  Q_PROPERTY(Esri::ArcGISRuntime::MapQuickView* mapView READ mapView WRITE setMapView NOTIFY mapViewChanged)
  Q_PROPERTY(int bufferSize READ bufferSize WRITE setBufferSize NOTIFY bufferSizeChanged)

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

  static void init();

  Q_INVOKABLE void clear();

signals:
  void mapViewChanged();
  void bufferSizeChanged();

private:
  Esri::ArcGISRuntime::MapQuickView* mapView() const;
  void setMapView(Esri::ArcGISRuntime::MapQuickView* mapView);
  int bufferSize() const;
  void setBufferSize(int size);
  void onMouseClicked(QMouseEvent& mouse);

  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;
  Esri::ArcGISRuntime::GraphicsOverlay* m_graphicsOverlayPlanar = nullptr;
  Esri::ArcGISRuntime::GraphicsOverlay* m_graphicsOverlayGeodesic = nullptr;
  Esri::ArcGISRuntime::GraphicsOverlay* m_graphicsOverlayPoints = nullptr;
  int m_bufferSize = 1000;
};

#endif // BUFFER_H

// [WriteFile Name=Buffer, Category=Geometry]
// [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
import Esri.Samples

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();
        }
    }

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

    // display a control pane to change size
    Rectangle {
        anchors {
            margins: -5
            fill: controlColumn
        }
        color: palette.base
        radius: 5
        border {
            color: "darkgray"
            width: 1
        }
    }

    Column {
        id: controlColumn
        anchors {
            left: parent.left
            top: parent.top
            margins: 10
        }
        spacing: 5

        Label {
            text: qsTr("Buffer size (miles):")
        }

        TextField {
            id: bufferSizeText
            validator: IntValidator { bottom: 1; top: 10000 }
            text: qsTr("1000")
            selectByMouse: true
            onTextChanged: model.bufferSize = Number(text);
        }

        Row {
            spacing: 10

            Rectangle {
                radius: 100
                width: 15
                height: width
                color: "blue"
                opacity: 0.5
            }

            Label {
                text: qsTr("Planar Buffer")
            }
        }

        Row {
            spacing: 10

            Rectangle {
                radius: 100
                width: 15
                height: width
                color: "red"
                opacity: 0.5
            }

            Label {
                text: qsTr("Geodesic Buffer")
            }
        }

        Button {
            anchors.horizontalCenter: parent.horizontalCenter
            text: qsTr("Clear")
            onClicked: {
                model.clear();
            }
        }
    }
}

// [WriteFile Name=Buffer, Category=Geometry]
// [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 "Buffer.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[])
{
  QGuiApplication app(argc, argv);
  app.setApplicationName(QString("Buffer"));

  // 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
  Buffer::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/Geometry/Buffer/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

    Buffer {
        anchors.fill: parent
    }
}