Set the terrain surface with elevation described by a local tile package.
Use case
In a scene view, the terrain surface is what the basemap, operational layers, and graphics are draped onto. For example, when viewing a scene in a mountainous region, applying a terrain surface to the scene will help in recognizing the slopes, valleys, and elevated areas.
How to use the sample
When loaded, the sample will show a scene with a terrain surface applied. Pan and zoom to explore the scene and observe how the terrain surface allows visualizing elevation differences.
How it works
- Create a
Scene
and add it to aSceneView
. - Create an
ArcGISTiledElevationSource
from a local tile package (.tpkx) - Add this source to the scene's base surface:
Scene::baseSurface::elevationSources::append(tileElevationSource)
Relevant API
- ArcGISTiledElevationSource
- Surface
Offline data
This sample uses the Monterey Elevation tile package, using CompactV2 storage format (.tpkx).
Read more about how to set up the sample's offline data here.
The tile package must be a LERC (limited error raster compression) encoded TPK/TPKX. Details on can be found in the topic Share a tile package in the ArcGIS Pro documentation.
Additional information
See the ArcGIS Pro Tile Package documentation (since Esri.ArcGISRuntime 100.1) for information on tile packages
Tags
3D, elevation, LERC, surface, terrain, tile cache
Sample Code
// [WriteFile Name=CreateTerrainSurfaceFromLocalTilePackage, 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
#include "CreateTerrainSurfaceFromLocalTilePackage.h"
#include "ArcGISTiledElevationSource.h"
#include "Scene.h"
#include "SceneQuickView.h"
#include <QDir>
#include <QUrl>
#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;
}
}
using namespace Esri::ArcGISRuntime;
CreateTerrainSurfaceFromLocalTilePackage::CreateTerrainSurfaceFromLocalTilePackage(QObject* parent /* = nullptr */):
QObject(parent),
m_scene(new Scene(BasemapStyle::ArcGISImageryStandard, this))
{
// create the MontereyElevation data path
// data is downloaded automatically by the sample viewer app. Instructions to download
// separately are specified in the readme.
const QString montereyTileElevationPath = QString{defaultDataPath() + "/ArcGIS/Runtime/Data/tpkx/MontereyElevation.tpkx"};
// Before attempting to add any layers, check that the file for the elevation source exists at all.
const bool srcElevationFileExists = QFileInfo::exists(montereyTileElevationPath);
if(srcElevationFileExists)
{
// Create the elevation source from the local raster(s). RasterElevationSource can take multiple files as inputs, but in this case only takes one.
ArcGISTiledElevationSource* elevationSrc = new ArcGISTiledElevationSource{montereyTileElevationPath, this};
// When the elevation source is finished loading, call the elevationSrcFinishedLoading callback, so we can tell if it loaded succesfully.
connect(elevationSrc, &ArcGISTiledElevationSource::doneLoading, this, &CreateTerrainSurfaceFromLocalTilePackage::elevationSrcFinishedLoading);
// add the elevation source to the scene to display elevation
m_scene->baseSurface()->elevationSources()->append(elevationSrc);
}
else
{
qDebug() << "Could not find file at : " << montereyTileElevationPath << ". Elevation source not set.";
}
}
void CreateTerrainSurfaceFromLocalTilePackage::elevationSrcFinishedLoading(Esri::ArcGISRuntime::Error loadError)
{
if(loadError.isEmpty())
{
// Succesful load
qDebug() << "Loaded tile elevation source succesfully";
}
else {
// Log failure to load
qDebug() << "Error loading elevation source : " << loadError.message();
}
}
CreateTerrainSurfaceFromLocalTilePackage::~CreateTerrainSurfaceFromLocalTilePackage() = default;
void CreateTerrainSurfaceFromLocalTilePackage::init()
{
// Register classes for QML
qmlRegisterType<SceneQuickView>("Esri.Samples", 1, 0, "SceneView");
qmlRegisterType<CreateTerrainSurfaceFromLocalTilePackage>("Esri.Samples", 1, 0, "CreateTerrainSurfaceFromLocalTilePackageSample");
}
SceneQuickView* CreateTerrainSurfaceFromLocalTilePackage::sceneView() const
{
return m_sceneView;
}
// Set the view (created in QML)
void CreateTerrainSurfaceFromLocalTilePackage::setSceneView(SceneQuickView* sceneView)
{
if (!sceneView || sceneView == m_sceneView)
{
return;
}
m_sceneView = sceneView;
m_sceneView->setArcGISScene(m_scene);
// Create a camera, looking at Monterey, California.
constexpr double latitude = 36.51;
constexpr double longitude = -121.80;
constexpr double altitude = 300.0;
constexpr double heading = 0.0;
constexpr double pitch = 70.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);
emit sceneViewChanged();
}