Display nautical charts per the ENC specification.
Use case
The ENC specification describes how hydrographic data should be displayed digitally.
An ENC exchange set is a catalog of data files which can be loaded as cells. The cells contain information on how symbols should be displayed in relation to one another, so as to represent information such as depth and obstacles accurately.
How to use the sample
Run the sample and view the ENC data. Pan and zoom around the map. Take note of the high level of detail in the data and the smooth rendering of the layer.
How it works
- Specify the path to a local CATALOG.031 file to create an
EncExchangeSet
. - After loading the exchange set, get the
EncDataset
objects in the exchange set withdatasets()
. - Create an
EncCell
for each dataset. Then create anEncLayer
for each cell. - Add the ENC layer to a map's operational layers collection to display it.
Relevant API
- EncCell
- EncDataset
- EncExchangeSet
- EncLayer
Offline data
To set up the sample's offline data, see the Use offline data in the samples section of the Qt Samples repository overview.
Link | Local Location |
---|---|
Exchange Set | <userhome> /ArcGIS/Runtime/Data/ENC/ExchangeSetwithoutUpdates |
Hydrography | <userhome> /ArcGIS/Runtime/Data/ENC/hydrography |
Tags
data, ENC, hydrographic, layers, maritime, nautical chart
Sample Code
// [WriteFile Name=AddEncExchangeSet, Category=Layers]
// [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
#include "AddEncExchangeSet.h"
#include "Map.h"
#include "MapQuickView.h"
#include "EncExchangeSet.h"
#include "EncLayer.h"
#include "EncDataset.h"
#include "EncCell.h"
#include "EncEnvironmentSettings.h"
#include "Envelope.h"
#include "GeometryEngine.h"
#include <QDir>
#include <QtCore/qglobal.h>
#ifdef Q_OS_IOS
#include <QStandardPaths>
#endif // Q_OS_IOS
using namespace Esri::ArcGISRuntime;
// helper method to get cross platform data path
namespace
{
QString defaultDataPath()
{
QString dataPath;
#ifdef Q_OS_ANDROID
dataPath = "/sdcard";
#elif defined Q_OS_IOS
dataPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
#else
dataPath = QDir::homePath();
#endif
return dataPath;
}
} // namespace
AddEncExchangeSet::AddEncExchangeSet(QObject* parent /* = nullptr */):
QObject(parent),
m_map(new Map(BasemapStyle::ArcGISOceans, this))
{
// set resource path
EncEnvironmentSettings::setResourcePath(defaultDataPath() + "/ArcGIS/Runtime/Data/ENC/hydrography");
// create ENC Exchange Set
QStringList encPaths = { defaultDataPath() + "/ArcGIS/Runtime/Data/ENC/ExchangeSetwithoutUpdates/ENC_ROOT/CATALOG.031" };
m_encExchangeSet = new EncExchangeSet(encPaths, this);
}
AddEncExchangeSet::~AddEncExchangeSet() = default;
void AddEncExchangeSet::init()
{
// Register the map view for QML
qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
qmlRegisterType<AddEncExchangeSet>("Esri.Samples", 1, 0, "AddEncExchangeSetSample");
}
MapQuickView* AddEncExchangeSet::mapView() const
{
return m_mapView;
}
// Set the view (created in QML)
void AddEncExchangeSet::setMapView(MapQuickView* mapView)
{
if (!mapView || mapView == m_mapView)
return;
m_mapView = mapView;
m_mapView->setMap(m_map);
// connect to doneLoading signal of EncExchangeSet
connect(m_encExchangeSet, &EncExchangeSet::doneLoading, this, [this](Error e)
{
if (!e.isEmpty())
return;
// loop through datasets
const auto datasets = m_encExchangeSet->datasets();
for (EncDataset* dataset : datasets)
{
// create an EncCell from each dataset
EncCell* cell = new EncCell(dataset, this);
// create an EncLayer from each cell
EncLayer* encLayer = new EncLayer(cell, this);
// connect to the doneLoading signal of the layer
connect(encLayer, &EncLayer::doneLoading, this, [this, encLayer](Error e)
{
if (!e.isEmpty())
return;
m_extents << encLayer->fullExtent();
if (m_extents.length() != m_encExchangeSet->datasets().length())
return;
// combine the extents
Envelope fullExtent = GeometryEngine::combineExtents(m_extents);
m_mapView->setViewpoint(fullExtent);
});
// add the layer to the map
m_map->operationalLayers()->append(encLayer);
}
});
// load the EncExchangeSet
m_encExchangeSet->load();
emit mapViewChanged();
}