Set surface navigation constraint | ArcGIS Maps SDK for Kotlin

View on GitHub

Sample viewer app

See through terrain in a scene and move the camera underground.

Image of add elevation source from tile package

Use case

By default, a scene's terrain is fully opaque, and the camera cannot go underground. To see underground features such as pipes in a utility network, you can lower the opacity of the terrain surface and set the navigation constraint on the surface to allow underground navigation.

How to use the sample

The sample loads a scene with underground features. Pan and zoom to explore the scene. Observe how the opacity of the base surface is reduced and the navigation constraint is removed, allowing you to pan and zoom through the base surface.

How it works

Display a ArcGISScene in a SceneView, which contains layers with underground features.
To see underground, get the scene's base surface and set its opacity to a value between 0 and 1.
To allow the camera to go underground, set the surface's navigation constraint to NavigationConstraint.None.

Relevant API

NavigationConstraint
Surface

About the data

This sample shows an Underground Wellbores and Seismic Events (Point Scene Layer) Webscene hosted on ArcGIS Online. The data displays a point scene layer showing underground wellbore paths (green polylines) and seismic events (orange points).

Sample Code

SetSurfaceNavigationConstraintViewModel.kt

MainActivity.kt

SetSurfaceNavigationConstraintScreen.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.setsurfacenavigationconstraint.components

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.NavigationConstraint
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.portal.Portal
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.launch

class SetSurfaceNavigationConstraintViewModel(app: Application) : AndroidViewModel(app) {

    // ArcGISScene created from a web scene portal item.
    // Configure the base surface to allow underground navigation and reduce opacity.
    val arcGISScene = ArcGISScene(
        item = PortalItem(
            portal = Portal.arcGISOnline(connection = Portal.Connection.Anonymous),
            itemId = "91a4fafd747a47c7bab7797066cb9272"
        )
    ).apply {
        // Allow the camera to move above and below the elevation surface.
        baseSurface.navigationConstraint = NavigationConstraint.None
        // Sets the opacity so that it is possible to see below the surface.
        baseSurface.opacity = 0.7f
    }

    // Message dialog view model for handling error messages
    val messageDialogVM = MessageDialogViewModel()

    init {
        viewModelScope.launch {
            // Load the scene and display an error if loading fails
            arcGISScene.load().onFailure { error ->
                messageDialogVM.showMessageDialog(
                    title = "Error loading scene",
                    description = error.message.toString()
                )
            }
        }
    }
}