Display a viewshed | ArcGIS Maps SDK for Kotlin

display a viewshed

Viewshed analysis determines the visibility of terrain, buildings, and other 3D objects from an observer’s location within a scene (using a specified field of view). The result indicates which areas are visible and which are obstructed when viewed from the observer’s perspective.

In this tutorial, you will perform and display a viewshed analysis in a web scene. Your viewshed analysis will show visibility (visible or obstructed) and can be used to determine which hotspots in the Yosemite Valley are visible from a specified observer’s perspective.

Prerequisites

Before starting this tutorial, you need the following:

An ArcGIS Location Platform or ArcGIS Online account.
A development and deployment environment that meets the system requirements.
An IDE for Android development in Kotlin.

Develop or download

You have two options for completing this tutorial:

Option 1: Develop the code or
Option 2: Download the completed solution

Option 1: Develop the code

Open an Android Studio project

Open the project you created by completing the Display a scene tutorial.
Continue with the following instructions to perform and display a viewshed analysis in a 3D scene.

Modify the old project for use in this new tutorial.

On your file system, delete the .idea folder, if present, at the top level of your project.
In the Android view, open app > res > values > strings.xml.

In the <string name="app_name"> element, change the text content to Display a viewshed.
strings.xml
<resources> <string name="app_name">Display a viewshed</string> </resources>

In the Android view, open Gradle Scripts > settings.gradle.kts.

Change the value of rootProject.name to “Display a viewshed”.

settings.gradle.kts

14 collapsed lines
pluginManagement {
    repositories {
        google {
            content {
                includeGroupByRegex("com\\.android.*")
                includeGroupByRegex("com\\.google.*")
                includeGroupByRegex("androidx.*")
            }
        }
        mavenCentral()
        gradlePluginPortal()
    }
}

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://esri.jfrog.io/artifactory/arcgis") }
    }
}

rootProject.name = "Display a viewshed"
include(":app")

Click File > Sync Project with Gradle files. Android Studio will recognize your changes and create a new .idea folder.

In libs.versions.toml, add a [libraries] entry for the dependency. In the module-level build.gradle.kts (app), add the dependency for the lifecycle view model.

19 collapsed lines
[versions]
arcgisMapsKotlin = "300.0.0"

# Version numbers added by Android Studio New Project Wizard
agp = "8.12.1"
kotlin = "2.2.10"
coreKtx = "1.17.0"
junit = "4.13.2"
junitVersion = "1.3.0"
espressoCore = "3.7.0"
lifecycleRuntimeKtx = "2.9.2"
activityCompose = "1.10.1"
composeBom = "2025.08.00"

# Other version numbers
compileSdk = "36"
minSdk = "28"
targetSdk = "36"

[libraries]
arcgis-maps-kotlin = { group = "com.esri", name = "arcgis-maps-kotlin", version.ref = "arcgisMapsKotlin" }
arcgis-maps-kotlin-toolkit-bom = { group = "com.esri", name = "arcgis-maps-kotlin-toolkit-bom", version.ref = "arcgisMapsKotlin" }
arcgis-maps-kotlin-toolkit-geoview-compose = { group = "com.esri", name = "arcgis-maps-kotlin-toolkit-geoview-compose" }
arcgis-maps-kotlin-toolkit-authentication = { group = "com.esri", name = "arcgis-maps-kotlin-toolkit-authentication" }
androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
junit = { group = "junit", name = "junit", version.ref = "junit" }
androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
androidx-lifecycle-runtime-ktx = { group = "androidx.lifecycle", name = "lifecycle-runtime-ktx", version.ref = "lifecycleRuntimeKtx" }

androidx-lifecycle-viewmodel-compose = { group = "androidx.lifecycle", name = "lifecycle-viewmodel-compose", version.ref = "lifecycleRuntimeKtx" }
15 collapsed lines

androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "activityCompose" }
androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" }
androidx-ui = { group = "androidx.compose.ui", name = "ui" }
androidx-ui-graphics = { group = "androidx.compose.ui", name = "ui-graphics" }
androidx-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling" }
androidx-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-tooling-preview" }
androidx-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" }
androidx-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4" }
androidx-material3 = { group = "androidx.compose.material3", name = "material3" }

[plugins]
android-application = { id = "com.android.application", version.ref = "agp" }
kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }

47 collapsed lines
plugins {
    alias(libs.plugins.android.application)
    alias(libs.plugins.kotlin.android)
    alias(libs.plugins.kotlin.compose)
}

android {
    namespace = "com.example.app"
    compileSdk = libs.versions.compileSdk.get().toInt()

    defaultConfig {
        applicationId = "com.example.app"
        minSdk = libs.versions.minSdk.get().toInt()
        targetSdk = libs.versions.targetSdk.get().toInt()
        versionCode = 1
        versionName = "1.0"
        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
        vectorDrawables {
            useSupportLibrary = true
        }
    }

    buildTypes {
        release {
            isMinifyEnabled = false
            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
        }
    }
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
    kotlinOptions {
        jvmTarget = "17"
    }
    buildFeatures {
        compose = true
    }
    packaging {
        resources {
            excludes += "/META-INF/{AL2.0,LGPL2.1}"
        }
    }
}

dependencies {

    implementation(libs.androidx.core.ktx)
    implementation(libs.androidx.lifecycle.runtime.ktx)
    implementation(libs.androidx.activity.compose)
    implementation(platform(libs.androidx.compose.bom))

    implementation(libs.androidx.lifecycle.viewmodel.compose)

    implementation(libs.androidx.ui)
    implementation(libs.androidx.ui.graphics)
19 collapsed lines

    implementation(libs.androidx.ui.tooling.preview)
    implementation(libs.androidx.material3)
    testImplementation(libs.junit)
    androidTestImplementation(libs.androidx.junit)
    androidTestImplementation(libs.androidx.espresso.core)
    androidTestImplementation(platform(libs.androidx.compose.bom))
    androidTestImplementation(libs.androidx.ui.test.junit4)
    debugImplementation(libs.androidx.ui.tooling)
    debugImplementation(libs.androidx.ui.test.manifest)

    // ArcGIS Maps for Kotlin - SDK dependency
    implementation(libs.arcgis.maps.kotlin)
    // Toolkit dependencies
    implementation(platform(libs.arcgis.maps.kotlin.toolkit.bom))
    implementation(libs.arcgis.maps.kotlin.toolkit.geoview.compose)
    implementation(libs.arcgis.maps.kotlin.toolkit.authentication)

}

Click File > Sync Project with Gradle files.

Add imports

Modify import statements to reference the packages and classes required for this tutorial.

MainScreen.kt

@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt

Get the web scene item ID

You can use ArcGIS tools Tools, also known as developer tools, are ArcGIS software applications such as portal and ArcGIS Pro that developers can use to prepare content and data for custom applications they are building. Learn more to create and view web scenes A web scene is a scene stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web scene specification. Learn more . Use the Scene Viewer Scene Viewer(™) is a browser-based mapping tool that can view, create, and save web scenes. Learn more to identify the web scene item ID An item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file. Learn more . This item ID will be used later in the tutorial.

Go to the Yosemite Valley Hotspots web scene in the Scene Viewer in ArcGIS Online ArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account. Learn more . This web scene displays terrain and hotspots in the Yosemite Valley.
Make a note of the item ID An item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file. Learn more at the end of the browser’s URL. The item ID should be 7558ee942b2547019f66885c44d4f0b1.

Create a view model

Modern app architecture uses a scene view model to hold the business logic and the mutual state of your app.

In Android Studio: in the Android view, open app > kotlin+java > com.example.app > screens > MainScreen.kt

Create a scene view model that extends ViewModel.

MainScreen.kt

42 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

}

5 collapsed lines

@Composable
fun MainScreen() {

}

In the MainScreen composable, delete the entire function body. Leave just the function declaration as shown below. Then delete the top-level code for creating a scene that is part of the Display a scene tutorial. In this tutorial, you will create the scene within the view model.

MainScreen.kt

109 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }

    fun hideViewshed() {
        viewshed.isVisible = false
    }

    fun setViewshedDistance(maxDistance: Double) {
        viewshed.maxDistance = maxDistance
    }

    fun handleOnLongPress(screenCoordinate: ScreenCoordinate) {
        viewModelScope.launch {
            val scenePoint = sceneViewProxy.screenToLocation(screenCoordinate).getOrElse { error ->
                return@launch logError(error)
            }
            setViewshedLocation(scenePoint)
        }
    }

    private fun logError(error: Throwable) {
        Log.e(this.javaClass.simpleName, error.message.toString(), error.cause)
    }

}


@Composable
fun MainScreen() {

}

MainScreen.kt

25 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Text
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import com.arcgismaps.geometry.Point
import com.arcgismaps.geometry.SpatialReference
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.ArcGISTiledElevationSource
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.Surface
import com.arcgismaps.mapping.Viewpoint
import com.arcgismaps.mapping.view.Camera
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.example.app.R

fun createScene(): ArcGISScene {

    // add base surface for elevation data
    val elevationSource = ArcGISTiledElevationSource("https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer")
    val surface = Surface().apply {
        elevationSources.add(elevationSource)
        // add an exaggeration factor to increase the 3D effect of the elevation.
        elevationExaggeration = 2.5f
    }

    val cameraLocation = Point(
        x = -118.794,
        y = 33.909,
        z = 5330.0,
        spatialReference = SpatialReference.wgs84()
    )

    val camera = Camera(
        locationPoint = cameraLocation,
        heading = 355.0,
        pitch = 72.0,
        roll = 0.0
    )

    return ArcGISScene(BasemapStyle.ArcGISImagery).apply {

        baseSurface = surface

        initialViewpoint = Viewpoint(cameraLocation, camera)

    }

}
20 collapsed lines

@Composable
fun MainScreen() {

    val scene = remember {
        createScene()
    }

    Scaffold(
        topBar = { TopAppBar(title = { Text(text = stringResource(id = R.string.app_name)) }) }
    ) {

        SceneView(
            modifier = Modifier.fillMaxSize().padding(it),
            arcGISScene = scene
        )

    }

}

In the view model, create an ArcGISScene from a PortalItem. Then create a SceneViewProxy.

MainScreen.kt

44 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()
8 collapsed lines

}


@Composable
fun MainScreen() {

}

Create a viewshed analysis

Visual analyses are used to help you make sense of complex 3D data contained by a scene. Use an ExploratoryLocationViewshed to perform and display a viewshed A viewshed represents the locations visible from one or more specified points or lines. Learn more analysis using a 3D point to define the observer’s location.

In the view model, create an AnalysisOverlay named analysisOverlay to contain and display the viewshed analyses.

An analysis overlay is a container for Analysis objects. It is used with a scene view A scene view is a user interface that displays scene layers and graphics in 3D. It uses a camera to control the visible area of the scene and supports user interactions such as pan, zoom, tilt, and rotate. Learn more to display visual analyses on a scene A scene is a collection of layers that are displayed in 3D. It is typically composed of a basemap layer, data layers, and 3D data. Learn more . You can add more than one analysis overlay to a scene view. Analysis overlays are displayed on top of all other layers A layer is a reference to a collection of geographic data that is used to access and display data. The data for layers are typically provided by the basemap layer service and data services. Learn more and graphics overlays A graphics overlay is a client-side, temporary container of graphics to display on a map view or scene view. Learn more .

SceneViewModel class

58 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()
8 collapsed lines

}


@Composable
fun MainScreen() {

}

Create an ExploratoryLocationViewshed named viewshed.

The viewshed analysis is added to a scene view A scene view is a user interface that displays scene layers and graphics in 3D. It uses a camera to control the visible area of the scene and supports user interactions such as pan, zoom, tilt, and rotate. Learn more using an analysis overlay. An analysis overlay is a container for analyses. It can be used to display visual analyses in a scene view. You can add more than one analysis overlay, and they are displayed on top of all other layers A layer is a reference to a collection of geographic data that is used to access and display data. The data for layers are typically provided by the basemap layer service and data services. Learn more .

SceneViewModel class

61 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )
8 collapsed lines

}


@Composable
fun MainScreen() {

}

In the init block, make the viewshed not visible upon launch and add the viewshed to the analysis overlay. Then load the scene. Since load() is a suspend function, call it from viewModelScope.launch.

SceneViewModel class

71 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }
8 collapsed lines

}


@Composable
fun MainScreen() {

}

Define a function named setViewshedLocation() that takes a Point as a parameter. This function sets the location of the viewshed and makes it visible, if it is not visible already.

SceneViewModel class

80 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }
8 collapsed lines

}


@Composable
fun MainScreen() {

}

Define a function named hideViewshed(), which hides the viewshed without modifying or deleting it. Then create a function named setViewshedDistance() to set a new maximum distance value for the viewshed.

SceneViewModel class

85 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }

    fun hideViewshed() {
        viewshed.isVisible = false
    }

    fun setViewshedDistance(maxDistance: Double) {
        viewshed.maxDistance = maxDistance
    }
8 collapsed lines

}


@Composable
fun MainScreen() {

}

Display the viewshed analysis with touch events

Touch events determine where to place the observer for the viewshed analysis. A user will long-press and drag to reveal and move the observer’s location.

Define a function named handleLongPressEvent() to add or move the viewshed analysis when the user long-presses on the scene. To obtain the new location (Point) in the scene, call screenToLocation() on the SceneViewProxy, passing in the screen coordinate of the long-press. Then call your setViewshedLocation() with the scene point.

SceneViewModel class

93 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }

    fun hideViewshed() {
        viewshed.isVisible = false
    }

    fun setViewshedDistance(maxDistance: Double) {
        viewshed.maxDistance = maxDistance
    }

    fun handleOnLongPress(screenCoordinate: ScreenCoordinate) {
        viewModelScope.launch {
            val scenePoint = sceneViewProxy.screenToLocation(screenCoordinate).getOrElse { error ->
                return@launch logError(error)
            }
            setViewshedLocation(scenePoint)
        }
    }
8 collapsed lines

}


@Composable
fun MainScreen() {

}

Define a function to log errors.

SceneViewModel class

102 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }

    fun hideViewshed() {
        viewshed.isVisible = false
    }

    fun setViewshedDistance(maxDistance: Double) {
        viewshed.maxDistance = maxDistance
    }

    fun handleOnLongPress(screenCoordinate: ScreenCoordinate) {
        viewModelScope.launch {
            val scenePoint = sceneViewProxy.screenToLocation(screenCoordinate).getOrElse { error ->
                return@launch logError(error)
            }
            setViewshedLocation(scenePoint)
        }
    }

    private fun logError(error: Throwable) {
        Log.e(this.javaClass.simpleName, error.message.toString(), error.cause)
    }
8 collapsed lines

}


@Composable
fun MainScreen() {

}

Add a UI to control the viewshed analysis

To control the viewshed analysis, some UI elements are required.

Create variables in the MainScreen composable.

Create sceneViewModel using viewModel().
Create sliderValue of type MutableFloatState. Since viewshed.maxDistance in the view model is a Double, but the value passed to Jetpack Compose Slider composable is a Float, you must convert the max distance to a Float.

MainScreen()

109 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }

    fun hideViewshed() {
        viewshed.isVisible = false
    }

    fun setViewshedDistance(maxDistance: Double) {
        viewshed.maxDistance = maxDistance
    }

    fun handleOnLongPress(screenCoordinate: ScreenCoordinate) {
        viewModelScope.launch {
            val scenePoint = sceneViewProxy.screenToLocation(screenCoordinate).getOrElse { error ->
                return@launch logError(error)
            }
            setViewshedLocation(scenePoint)
        }
    }

    private fun logError(error: Throwable) {
        Log.e(this.javaClass.simpleName, error.message.toString(), error.cause)
    }

}


@Composable
fun MainScreen() {

    val sceneViewModel: SceneViewModel = viewModel()
    // If viewshed.maxDistance is not null, assign it to maxDistance. Otherwise, assign default of 1000.0
    var sliderValue by remember {
        mutableFloatStateOf(sceneViewModel.viewshed.maxDistance?.toFloat() ?: 1000.0f)
    }

}

Add a Scaffold and pass a TopAppBar. The Scaffold’s content lambda contains a Column.

MainScreen()

109 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }

    fun hideViewshed() {
        viewshed.isVisible = false
    }

    fun setViewshedDistance(maxDistance: Double) {
        viewshed.maxDistance = maxDistance
    }

    fun handleOnLongPress(screenCoordinate: ScreenCoordinate) {
        viewModelScope.launch {
            val scenePoint = sceneViewProxy.screenToLocation(screenCoordinate).getOrElse { error ->
                return@launch logError(error)
            }
            setViewshedLocation(scenePoint)
        }
    }

    private fun logError(error: Throwable) {
        Log.e(this.javaClass.simpleName, error.message.toString(), error.cause)
    }

}


@Composable
fun MainScreen() {

    val sceneViewModel: SceneViewModel = viewModel()
    // If viewshed.maxDistance is not null, assign it to maxDistance. Otherwise, assign default of 1000.0
    var sliderValue by remember {
        mutableFloatStateOf(sceneViewModel.viewshed.maxDistance?.toFloat() ?: 1000.0f)
    }

    Scaffold(
        topBar = { TopAppBar(title = { Text(text = stringResource(id = R.string.app_name)) }) }
    ) { innerPadding ->
        Column(
            modifier = Modifier.padding(innerPadding),
            horizontalAlignment = Alignment.CenterHorizontally,
            verticalArrangement = Arrangement.spacedBy(12.dp)
        ) {

        }
    }

}

In the Column’s content lambda, add the SceneView composable. For the arcGISScene, sceneViewProxy, and analysisOverlays parameters, pass the corresponding properties from sceneViewModel. For onLongPress, pass a lambda that calls sceneViewModel.handleOnLongPress().

MainScreen()

118 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }

    fun hideViewshed() {
        viewshed.isVisible = false
    }

    fun setViewshedDistance(maxDistance: Double) {
        viewshed.maxDistance = maxDistance
    }

    fun handleOnLongPress(screenCoordinate: ScreenCoordinate) {
        viewModelScope.launch {
            val scenePoint = sceneViewProxy.screenToLocation(screenCoordinate).getOrElse { error ->
                return@launch logError(error)
            }
            setViewshedLocation(scenePoint)
        }
    }

    private fun logError(error: Throwable) {
        Log.e(this.javaClass.simpleName, error.message.toString(), error.cause)
    }

}


@Composable
fun MainScreen() {

    val sceneViewModel: SceneViewModel = viewModel()
    // If viewshed.maxDistance is not null, assign it to maxDistance. Otherwise, assign default of 1000.0
    var sliderValue by remember {
        mutableFloatStateOf(sceneViewModel.viewshed.maxDistance?.toFloat() ?: 1000.0f)
    }

    Scaffold(
        topBar = { TopAppBar(title = { Text(text = stringResource(id = R.string.app_name)) }) }
    ) { innerPadding ->
        Column(
            modifier = Modifier.padding(innerPadding),
            horizontalAlignment = Alignment.CenterHorizontally,
            verticalArrangement = Arrangement.spacedBy(12.dp)
        ) {

            SceneView(
                modifier = Modifier
                    .fillMaxSize()
                    .weight(1f),
                arcGISScene = sceneViewModel.scene,
                sceneViewProxy = sceneViewModel.sceneViewProxy,
                analysisOverlays = listOf(sceneViewModel.analysisOverlay),
                onLongPress = { longPressEvent ->
                    sceneViewModel.handleOnLongPress(longPressEvent.screenCoordinate)
                }
            )

        }
    }
2 collapsed lines

}

Add a Text to display the current value of the slider.

Add a Row that will contain a Slider and a TextButton.

The slider allows the user to adjust the maximum distance of the viewshed in the range of 0f..20999f. The value parameter is the current value of the slider, which is held in the sliderValue variable of the MainScreen composable. For the onValuechange parameters pass a lambda that saves the new value of the slider in the sliderValue variable and then calls setViewshedDistance() in the view model. Changing the maximum distance of the viewshed expands or contracts the size of the observer’s field of view.

The text button says “Clear” and calls the view model’s hideViewshed() when clicked. This allows the user a fresh start to make more analyses.

MainScreen()

139 collapsed lines
@file:OptIn(ExperimentalMaterial3Api::class)

package com.example.app.screens

import android.util.Log
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Slider
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.TopAppBar
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.analysis.interactive.ExploratoryLocationViewshed
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISScene
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.view.AnalysisOverlay
import com.arcgismaps.mapping.view.ScreenCoordinate
import com.arcgismaps.portal.Portal
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.example.app.R
import kotlinx.coroutines.launch
import kotlin.math.roundToInt


class SceneViewModel : ViewModel() {

    private val portal = Portal(
        url = "https://www.arcgis.com",
        connection = Portal.Connection.Anonymous
    )

    private val portalItem = PortalItem(
        portal = portal,
        itemId = "7558ee942b2547019f66885c44d4f0b1"
    )

    var scene = ArcGISScene(portalItem)

    val sceneViewProxy = SceneViewProxy()

    // The analysis overlay to be added to the scene.
    val analysisOverlay = AnalysisOverlay()

    var viewshed = ExploratoryLocationViewshed(
        location = Point(x = 0.0, y = 0.0),
        heading = 0.0,
        pitch = 90.0,
        horizontalAngle = 360.0,
        verticalAngle = 180.0,
        minDistance = 10.0,
        maxDistance = 12_000.0
    )

    init {
        viewshed.isVisible = false
        analysisOverlay.analyses.add(viewshed)

        viewModelScope.launch {
            scene.load().getOrElse { logError(it) }
        }
    }

    private fun setViewshedLocation(point: Point) {
        viewshed.location = point
        viewshed.isVisible = true
    }

    fun hideViewshed() {
        viewshed.isVisible = false
    }

    fun setViewshedDistance(maxDistance: Double) {
        viewshed.maxDistance = maxDistance
    }

    fun handleOnLongPress(screenCoordinate: ScreenCoordinate) {
        viewModelScope.launch {
            val scenePoint = sceneViewProxy.screenToLocation(screenCoordinate).getOrElse { error ->
                return@launch logError(error)
            }
            setViewshedLocation(scenePoint)
        }
    }

    private fun logError(error: Throwable) {
        Log.e(this.javaClass.simpleName, error.message.toString(), error.cause)
    }

}


@Composable
fun MainScreen() {

    val sceneViewModel: SceneViewModel = viewModel()
    // If viewshed.maxDistance is not null, assign it to maxDistance. Otherwise, assign default of 1000.0
    var sliderValue by remember {
        mutableFloatStateOf(sceneViewModel.viewshed.maxDistance?.toFloat() ?: 1000.0f)
    }

    Scaffold(
        topBar = { TopAppBar(title = { Text(text = stringResource(id = R.string.app_name)) }) }
    ) { innerPadding ->
        Column(
            modifier = Modifier.padding(innerPadding),
            horizontalAlignment = Alignment.CenterHorizontally,
            verticalArrangement = Arrangement.spacedBy(12.dp)
        ) {

            SceneView(
                modifier = Modifier
                    .fillMaxSize()
                    .weight(1f),
                arcGISScene = sceneViewModel.scene,
                sceneViewProxy = sceneViewModel.sceneViewProxy,
                analysisOverlays = listOf(sceneViewModel.analysisOverlay),
                onLongPress = { longPressEvent ->
                    sceneViewModel.handleOnLongPress(longPressEvent.screenCoordinate)
                }
            )

            Text(text = "Viewshed max distance: "+sliderValue.roundToInt().toString())
            Row {
                Slider(
                    modifier = Modifier.weight(1f),
                    value = sliderValue,
                    valueRange = 0f..20999f,
                    onValueChange = {
                        sliderValue = it
                        sceneViewModel.setViewshedDistance(sliderValue.toDouble())
                    },
                )
                TextButton(onClick = { sceneViewModel.hideViewshed() }) {
                    Text(text = "Clear")
                }
            }
5 collapsed lines

        }
    }

}

Click Run > Run > app to run the app.

You should see a scene of hotspots in the Yosemite Valley. Long-press and drag to display and move a viewshed analysis to explore the visibility of terrain from various locations.

Alternatively, you can download the tutorial solution, as follows.

Option 2: Download the solution

Click the Download solution link in the right-hand side of this page.
Unzip the file to a location on your machine.
Run Android Studio.
Go to File > Open…. Navigate to the solution folder and click Open.

On Windows: If you are in the Welcome to Android Studio dialog, click Open and navigate to the solution folder. Then click Open.

Since the downloaded solution does not contain authentication credentials, you must first set up authentication to create credentials, and then add the developer credentials to the solution.

Set up authentication

To access the secure ArcGIS location services ArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services. Learn more used in this tutorial, you must implement API key authentication API key authentication is a type of authentication that uses an API key to authenticate requests to ArcGIS services and secure portal items. Learn more or user authentication User authentication is a type of authentication that allows users with an ArcGIS account to sign into an application and allow it to access ArcGIS content, services, and resources on their behalf. The typical authorization protocol used is OAuth2.0. Learn more using an ArcGIS Location Platform An ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription. Learn more or an ArcGIS Online An ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization. Learn more account.

You can implement API key authentication or user authentication in this tutorial. Compare the differences below:

API key authentication API key authentication is a type of authentication that uses an API key to authenticate requests to ArcGIS services and secure portal items. Learn more

Users are not required to sign in.
Requires creating an API key credential API key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential. Learn more with the correct privileges.
API keys An API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications. Learn more are long-lived access tokens.
Service usage is billed to the API key owner/developer.
Simplest authentication method to implement.
Recommended approach for new ArcGIS developers.

Learn more in API key authentication.

User authentication User authentication is a type of authentication that allows users with an ArcGIS account to sign into an application and allow it to access ArcGIS content, services, and resources on their behalf. The typical authorization protocol used is OAuth2.0. Learn more

Users are required to sign in with an ArcGIS account An ArcGIS account is an identity with a user type and set of privileges that can access specific ArcGIS products, tools, APIs, services, and resources. The main account types that can be used for development are an ArcGIS Location Platform account, ArcGIS Online account, and ArcGIS Enterprise account. ArcGIS Location Platform and ArcGIS Online accounts are also associated with a subscription. Learn more .
User accounts must have privilege Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. Learn more to access the ArcGIS services A service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise. Learn more used in application.
Requires creating OAuth credentials OAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential. Learn more .
Application uses a redirect URL and client ID.
Service usage is billed to the organization of the user signed into the application.

Learn more in User authentication.

To complete this tutorial, click on the tab in the switcher below for your authentication type of choice, either API key authentication or User authentication.

Create a new API key access token An access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. Learn more with privileges Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. Learn more to access the secure resources used in this tutorial.

Complete the Create an API key tutorial and create an API key with the following privilege(s) Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. Learn more :
- Privileges
  - Location services > Basemaps
Copy and paste the API key access token into a safe location. It will be used in a later step.

Create new OAuth credentials to access the secure resources used in this tutorial.

Complete the Create OAuth credentials for user authentication tutorial to obtain a Client ID and Redirect URL.

A Client ID uniquely identifies your app on the authenticating server. If the server cannot find an app with the provided Client ID, it will not proceed with authentication.
The Redirect URL (also referred to as a callback url) is used to identify a response from the authenticating server when the system returns control back to your app after an OAuth login. Since it does not necessarily represent a valid endpoint that a user could navigate to, the redirect URL can use a custom scheme, such as my-app://auth. It is important to make sure the redirect URL used in your app’s code matches a redirect URL configured on the authenticating server.
Copy and paste the Client ID and Redirect URL into a safe location. They will be used in a later step.

All users that access this application need account privileges Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. Learn more to access the ArcGIS Basemap Styles service The ArcGIS Basemap Styles service, also referred to as the Basemap Styles service, is a location service that provides basemap styles and data for the world. It returns styles as Mapbox styles and web maps, and data as vector tiles and/or map tiles. It supports all of the styles in the ArcGIS Basemap style and Open Basemap style family. An ArcGIS Location Platform or ArcGIS Online account is required to use the service. Learn more .

Set developer credentials in the solution

To allow your app users to access ArcGIS location services ArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services. Learn more , use the developer credentials that you created in the Set up authentication step to authenticate requests for resources.

In the Android view of Android Studio, open app > kotlin+java > com.example.app > MainActivity. Set the AuthenticationMode to .API_KEY.

MainActivity.kt

14 collapsed lines
package com.example.app

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.arcgismaps.httpcore.authentication.OAuthUserConfiguration
import com.arcgismaps.toolkit.authentication.AuthenticatorState
import com.arcgismaps.toolkit.authentication.DialogAuthenticator
import com.example.app.screens.MainScreen
import com.example.app.ui.theme.TutorialTheme

class MainActivity : ComponentActivity() {

    private enum class AuthenticationMode { API_KEY, USER_AUTH }

    private val authenticationMode = AuthenticationMode.API_KEY
42 collapsed lines

    private val authenticatorState = AuthenticatorState()

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

        when (authenticationMode) {
            AuthenticationMode.API_KEY -> {

                ArcGISEnvironment.apiKey = ApiKey.create("YOUR_ACCESS_TOKEN")

            }

            AuthenticationMode.USER_AUTH -> {
                authenticatorState.oAuthUserConfigurations = listOf(
                    OAuthUserConfiguration(
                        portalUrl = "https://www.arcgis.com",

                        clientId = "YOUR_CLIENT_ID",
                        redirectUrl = "YOUR_REDIRECT_URL"

                    )
                )

            }
        }

        enableEdgeToEdge()

        setContent {
            TutorialTheme {
                MainScreen()

                if (authenticationMode == AuthenticationMode.USER_AUTH) {
                    DialogAuthenticator(authenticatorState)
                }

            }
        }
    }

}

Set the apiKey property with your API key access token.

MainActivity.kt

22 collapsed lines
package com.example.app

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.arcgismaps.httpcore.authentication.OAuthUserConfiguration
import com.arcgismaps.toolkit.authentication.AuthenticatorState
import com.arcgismaps.toolkit.authentication.DialogAuthenticator
import com.example.app.screens.MainScreen
import com.example.app.ui.theme.TutorialTheme

class MainActivity : ComponentActivity() {

    private enum class AuthenticationMode { API_KEY, USER_AUTH }

    private val authenticationMode = AuthenticationMode.API_KEY

    private val authenticatorState = AuthenticatorState()

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

        when (authenticationMode) {
            AuthenticationMode.API_KEY -> {

                ArcGISEnvironment.apiKey = ApiKey.create("YOUR_ACCESS_TOKEN")

            }
30 collapsed lines

            AuthenticationMode.USER_AUTH -> {
                authenticatorState.oAuthUserConfigurations = listOf(
                    OAuthUserConfiguration(
                        portalUrl = "https://www.arcgis.com",

                        clientId = "YOUR_CLIENT_ID",
                        redirectUrl = "YOUR_REDIRECT_URL"

                    )
                )

            }
        }

        enableEdgeToEdge()

        setContent {
            TutorialTheme {
                MainScreen()

                if (authenticationMode == AuthenticationMode.USER_AUTH) {
                    DialogAuthenticator(authenticatorState)
                }

            }
        }
    }

}

Best Practice: The access token is stored directly in the code as a convenience for this tutorial. Do not store credentials directly in source code in a production environment.

In the Android view of Android Studio, open app > kotlin+java > com.example.app > MainActivity. Set the AuthenticationMode to .USER_AUTH.

MainActivity.kt

class MainActivity : ComponentActivity() {
    private enum class AuthenticationMode { API_KEY, USER_AUTH }

    private val authenticationMode = AuthenticationMode.USER_AUTH

Set your clientID and redirectURL values. You must use the RedirectURL that you supplied for your app in the user authentication part of the Set up authentication step.

MainActivity.kt

            AuthenticationMode.USER_AUTH -> {
                authenticatorState.oAuthUserConfigurations = listOf(
                    OAuthUserConfiguration(
                        portalUrl = "https://www.arcgis.com",

                        clientId = "YOUR_CLIENT_ID",
                        redirectUrl = "YOUR_REDIRECT_URL"

                    )
                )

Open app > manifests > AndroidManifest.xml.

Set the android:scheme and android:host using the scheme and host from your RedirectURL.

A redirectURL is composed of a scheme and a host component. The format for the redirect url is scheme://host. For example, if the redirect url is myscheme://myhost then the scheme is myscheme and the host is myhost.

AndroidManifest.xml

41 collapsed lines
<?xml version="1.0" encoding="utf-8"?>

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

    <uses-permission android:name="android.permission.INTERNET" />

    <application
        android:allowBackup="true"
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:fullBackupContent="@xml/backup_rules"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.Tutorial"
        tools:targetApi="31">
        <activity
            android:name=".MainActivity"
            android:exported="true"
            android:label="@string/app_name"
            android:theme="@style/Theme.Tutorial">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>

        </activity>

        <activity
            android:name="com.arcgismaps.toolkit.authentication.AuthenticationActivity"
            android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
            android:exported="true"
            android:launchMode="singleTop" >
            <intent-filter>
                <action android:name="android.intent.action.VIEW" />

                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />

                <data
                    android:scheme="your_redirect_url_scheme"
                    android:host="your_redirect_url_host" />
6 collapsed lines

            </intent-filter>
        </activity>

    </application>
</manifest>

Best Practice: The OAuth credentials are stored directly in the code as a convenience for this tutorial. Do not store credentials directly in source code in a production environment.

Run the app

Click Run > Run > app to run the app.

You should see a scene of trails, trailheads and parks in the Santa Monica Mountains. Drag, swipe, or pinch on the scene view to explore the scene.

What’s next?

Learn how to use additional API features, ArcGIS location services, and ArcGIS tools in these tutorials:

Spatial analysisExploratory analysis NextUtility network