Display local scene | ArcGIS Maps SDK for Kotlin

View on GitHub

Sample viewer app

Display a local scene with a topographic surface and 3D scene layer clipped to a local area.

Image of display local scene

Use case

A LocalSceneView is a user interface that displays 3D basemaps and layer content described in an ArcGisScene with a local SceneViewingMode.

Unlike a global scene which is drawn on a globe using a geographic coordinate system, a local scene is drawn on a flat surface and supports projected coordinate systems. They are generally used to view local data and are often clipped to a specific area of interest. Currently, LocalSceneView cannot display data provided by a global scene and SceneView cannot display data provided by a local scene.

The LocalSceneView displays the clipped area of the local scene, supports user interactions such as pan and zoom, and provides access to the underlying scene data.

How to use the sample

This sample displays a local scene clipped to an extent. Pan and zoom to explore the scene.

How it works

Create a local scene object with the ArcGISScene(arcGISTopographic, SceneViewingMode.local) constructor.
Create an ArcGISTiledElevationSource object and add it to the local scene's base surface.
Create an ArcGISSceneLayer and add it to the local scene's operational layers.
Create an Envelope and set it to the scene.clippingArea, then enable clipping by setting scene.isClippingEnabled to true.
Create a LocalSceneView object to display the scene.
Set the initial viewpoint for the local scene.
Set the local scene to the local scene view.

Relevant API

ArcGISScene
ArcGISSceneLayer
ArcGISTiledElevationSource
LocalSceneView

Additional information

This sample requires a device capable of OpenGL ES 3.2 and will not run on an emulator.

Sample Code

MainActivity.kt

DisplayLocalSceneScreen.kt

Use dark colors for code blocksCopy
/* Copyright 2025 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.arcgismaps.sample.displaylocalscene

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.runtime.Composable
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme
import com.esri.arcgismaps.sample.displaylocalscene.screens.DisplayLocalSceneScreen

class MainActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // authentication with an API key or named user is
        // required to access basemaps and other location services
        ArcGISEnvironment.apiKey = ApiKey.create(BuildConfig.ACCESS_TOKEN)

        setContent {
            SampleAppTheme {
                DisplayLocalSceneApp()
            }
        }
    }

    @Composable
    private fun DisplayLocalSceneApp() {
        Surface(color = MaterialTheme.colorScheme.background) {
            DisplayLocalSceneScreen(
                sampleName = getString(R.string.display_local_scene_app_name)
            )
        }
    }
}