Raster rendering rule

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

// ArcGIS Maps SDK headers
#include "ArcGISImageServiceInfo.h"
#include "Basemap.h"
#include "Envelope.h"
#include "Error.h"
#include "ImageServiceRaster.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "MapViewTypes.h"
#include "RasterLayer.h"
#include "RenderingRule.h"
#include "RenderingRuleInfo.h"
#include "Viewpoint.h"

// Qt headers
#include <QFuture>
#include <QJsonDocument>
#include <QJsonObject>

using namespace Esri::ArcGISRuntime;

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

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

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

  // find QML MapView component
  m_mapView = findChild<MapQuickView*>("mapView");
  m_mapView->setWrapAroundMode(WrapAroundMode::Disabled);

  m_map = new Map(BasemapStyle::ArcGISStreets, this);
  m_mapView->setMap(m_map);

  //! [RasterRenderingRule cpp ImageServiceRaster]
  // set the url
  m_url = QUrl("https://sampleserver6.arcgisonline.com/arcgis/rest/services/CharlotteLAS/ImageServer");

  // create an image service raster
  m_imageServiceRaster = new ImageServiceRaster(m_url, this);

  // zoom to the raster's extent once it's loaded
  connect(m_imageServiceRaster, &ImageServiceRaster::doneLoading, this, [this]()
  {
    // set the extent of the mapview to the extent defined in the image service raster's service info
    m_mapView->setViewpointAsync(Viewpoint(m_imageServiceRaster->serviceInfo().fullExtent()));

    // get the rendering rule infos
    const QList<RenderingRuleInfo> renderingRuleInfos = m_imageServiceRaster->serviceInfo().renderingRuleInfos();
    if (renderingRuleInfos.length() > 0)
    {
      for (const RenderingRuleInfo& renderingRuleInfo : renderingRuleInfos)
      {
        // populate the list with the rendering rule names
        m_renderingRuleNames << renderingRuleInfo.name();
      }
      emit renderingRuleNamesChanged();
    }
  });
  //! [RasterRenderingRule cpp ImageServiceRaster]

  // create a raster layer using the image service raster
  m_rasterLayer = new RasterLayer(m_imageServiceRaster, this);
  // add the raster layer to the map's operational layers
  m_map->operationalLayers()->append(m_rasterLayer);
}

void RasterRenderingRule::applyRenderingRule(int index)
{
  //! [ImageServiceRaster Create a rendering rule]
  // get the rendering rule info from the service info
  RenderingRuleInfo renderingRuleInfo = m_imageServiceRaster->serviceInfo().renderingRuleInfos().at(index);
  // create a new rendering rule with the rendering rule info
  RenderingRule* renderingRule = new RenderingRule(renderingRuleInfo, this);
  // create an image service raster
  ImageServiceRaster* isr = new ImageServiceRaster(m_url, this);
  // set the rendering rule
  isr->setRenderingRule(renderingRule);
  //! [ImageServiceRaster Create a rendering rule]
  // create a new raster layer using the image service raster
  RasterLayer* rasterLayer = new RasterLayer(isr, this);
  // add the raster layer to the map
  m_map->operationalLayers()->append(rasterLayer);
}

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

// Qt headers
#include <QQuickItem>

namespace Esri::ArcGISRuntime
{
  class Basemap;
  class Map;
  class MapQuickView;
  class RasterLayer;
  class ImageServiceRaster;
}

class RasterRenderingRule : public QQuickItem
{
  Q_OBJECT
  Q_PROPERTY(QStringList renderingRuleNames MEMBER m_renderingRuleNames NOTIFY renderingRuleNamesChanged)

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

  static void init();
  void componentComplete() override;
  Q_INVOKABLE void applyRenderingRule(int index);

signals:
  void renderingRuleNamesChanged();

private:
  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;
  Esri::ArcGISRuntime::RasterLayer* m_rasterLayer = nullptr;
  Esri::ArcGISRuntime::ImageServiceRaster* m_imageServiceRaster = nullptr;
  QStringList m_renderingRuleNames;
  QUrl m_url;
};

#endif // RasterRenderingRule_H

// [WriteFile Name=RasterRenderingRule, Category=Layers]
// [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 QtQuick.Layouts
import Esri.Samples

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

    // add a mapView component
    MapView {
        anchors.fill: parent
        objectName: "mapView"

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

        Rectangle {
            anchors {
                left: parent.left
                top: parent.top
                margins: 5
            }
            height: childrenRect.height
            width: childrenRect.width
            color: "silver"
            radius: 5

            GridLayout {
                columns: 2

                Label {
                    Layout.margins: 10
                    Layout.columnSpan: 2
                    Layout.alignment: Qt.AlignHCenter
                    text: "Apply a Rendering Rule"
                    font.pixelSize: 16
                }

                ComboBox {
                    id: renderingRulesCombo
                    property int modelWidth: 0
                    Layout.minimumWidth: modelWidth + leftPadding + rightPadding + (indicator ? indicator.width : 10)
                    Layout.margins: 10
                    model: renderingRuleNames

                    onModelChanged: {
                        for (let i = 0; i < model.length; ++i) {
                            metrics.text = model[i];
                            modelWidth = Math.max(modelWidth, metrics.width);
                        }
                    }
                    TextMetrics {
                        id: metrics
                        font: renderingRulesCombo.font
                    }
                }

                Button {
                    id: applyButton
                    Layout.margins: 10
                    text: "Apply"
                    onClicked: {
                        applyRenderingRule(renderingRulesCombo.currentIndex);
                    }
                }
            }
        }
    }
}

// [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 "RasterRenderingRule.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("RasterRenderingRule"));

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

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

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

  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 Runtime and Extras path
  view.engine()->addImportPath(arcGISRuntimeImportPath);

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

  view.show();

  return app.exec();
}