Create terrain from a local tile package

View inJavaKotlinView on GitHubSample viewer app

Set the terrain surface with elevation described by a local tile package.

Image of create terrain from 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

  1. Create an ArcGISScene and add it to a SceneView.
  2. Create an ArcGISTiledElevationSource with the path to the local tile package.
  3. Add this source to the scene's base surface: ArcGISScene.baseSurface.elevationSources.add(ArcGISTiledElevationSource).

Relevant API

  • ArcGISTiledElevationSource
  • Surface

Offline data

  1. Download the data from ArcGIS Online.
  2. Extract the contents of the downloaded zip file to disk.
  3. Open your command prompt and navigate to the folder where you extracted the contents of the data from step 1.
  4. Execute the following command:

adb push MontereyElevation.tpkx /Android/data/com.esri.arcgisruntime.sample.createterrainfromalocaltilepackage/files/MontereyElevation.tpkx

Link Local Location
Monterey Elevation TPKX /Android/data/com.esri.arcgisruntime.sample.createterrainfromalocaltilepackage/files/MontereyElevation.tpkx

Additional information

The tile package must be a LERC (limited error raster compression) encoded TPKX. Details on can be found in the topic Share a tile package in the ArcGIS Pro documentation.

Tags

3D, elevation, LERC, surface, terrain, tile cache

Sample Code

MainActivity.kt
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
 * 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.
 */

package com.esri.arcgisruntime.samples.createterrainfromalocaltilepackage

import android.os.Bundle
import android.util.Log
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
import com.esri.arcgisruntime.loadable.LoadStatus
import com.esri.arcgisruntime.mapping.ArcGISScene
import com.esri.arcgisruntime.mapping.ArcGISTiledElevationSource
import com.esri.arcgisruntime.mapping.BasemapStyle
import com.esri.arcgisruntime.mapping.view.Camera
import com.esri.arcgisruntime.mapping.view.SceneView
import com.esri.arcgisruntime.samples.createterrainfromalocaltilepackage.databinding.ActivityMainBinding

class MainActivity : AppCompatActivity() {

    private val activityMainBinding by lazy {
        ActivityMainBinding.inflate(layoutInflater)
    }

    private val sceneView: SceneView by lazy {
        activityMainBinding.sceneView
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(activityMainBinding.root)

        // authentication with an API key or named user is required to access basemaps and other
        // location services
        ArcGISRuntimeEnvironment.setApiKey(BuildConfig.API_KEY)

        // create and add a scene with an imagery basemap
        sceneView.scene = ArcGISScene(BasemapStyle.ARCGIS_IMAGERY)

        // specify the initial camera position
        sceneView.setViewpointCamera(Camera(36.525, -121.80, 300.0, 180.0, 80.0, 0.0))

        // add a ArcGISTiledElevationSource to the scene by passing the URI of the local tile package to the constructor
        with(
            ArcGISTiledElevationSource(
                getExternalFilesDir(null)?.path + getString(R.string.local_tile_package_location)
            )
        ) {
            // add a listener to perform operations when the load status of the ArcGISTiledElevationSource changes
            this.addLoadStatusChangedListener { loadStatusChangedEvent ->
                // when ArcGISTiledElevationSource loads
                if (loadStatusChangedEvent.newLoadStatus == LoadStatus.LOADED) {
                    // add the ArcGISTiledElevationSource to the elevation sources of the scene
                    sceneView.scene.baseSurface.elevationSources.add(this)
                } else if (loadStatusChangedEvent.newLoadStatus == LoadStatus.FAILED_TO_LOAD) {
                    // notify user that the ArcGISTiledElevationSource has failed to load
                    logErrorToUser(getString(R.string.error_tiled_elevation_source_load_failure_message))
                }
            }

            // load the ArcGISTiledElevationSource asynchronously
            this.loadAsync()
        }
    }

    /**
     * AppCompatActivity Extensions
     **/
    private val AppCompatActivity.logTag get() = this::class.java.simpleName

    private fun AppCompatActivity.logErrorToUser(message: String) {
        Toast.makeText(this, message, Toast.LENGTH_LONG).show()
        Log.e(logTag, message)
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.