Colinanderson/play kml tour compose

samples/play-kml-tour/README.md

@@ -34,6 +34,8 @@ This sample uses a custom tour from [ArcGIS Online](https://arcgisruntime.maps.a
 
 See [Touring in KML](https://developers.google.com/kml/documentation/touring) in *Keyhole Markup Language* for more information.
 
+This sample uses the GeoViewCompose Toolkit module to be able to implement a Composable SceneView.
+
 ## Tags
 
-animation, interactive, KML, narration, pause, play, story, tour
+animation, geoviewcompose, interactive, KML, narration, pause, play, story, toolkit, tour

samples/play-kml-tour/README.metadata.json

@@ -9,11 +9,13 @@
     "keywords": [
         "KML",
         "animation",
+        "geoviewcompose",
         "interactive",
         "narration",
         "pause",
         "play",
         "story",
+        "toolkit",
         "tour",
         "KmlTour",
         "KmlTourController",
@@ -31,8 +33,10 @@
         "KmlTourController.reset()"
     ],
     "snippets": [
+        "src/main/java/com/esri/arcgismaps/sample/playkmltour/components/PlayKMLTourViewModel.kt",
+        "src/main/java/com/esri/arcgismaps/sample/playkmltour/DownloadActivity.kt",
         "src/main/java/com/esri/arcgismaps/sample/playkmltour/MainActivity.kt",
-        "src/main/java/com/esri/arcgismaps/sample/playkmltour/DownloadActivity.kt"
+        "src/main/java/com/esri/arcgismaps/sample/playkmltour/screens/PlayKMLTourScreen.kt"
     ],
     "title": "Play KML tour"
-}
+}

samples/play-kml-tour/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     alias(libs.plugins.arcgismaps.android.library)
+    alias(libs.plugins.arcgismaps.android.library.compose)
     alias(libs.plugins.arcgismaps.kotlin.sample)
     alias(libs.plugins.gradle.secrets)
 }
@@ -11,9 +12,7 @@ secrets {
 
 android {
     namespace = "com.esri.arcgismaps.sample.playkmltour"
-    // For view based samples
     buildFeatures {
-        dataBinding = true
         buildConfig = true
     }
 }

samples/play-kml-tour/src/main/AndroidManifest.xml

@@ -4,15 +4,11 @@
     <uses-permission android:name="android.permission.INTERNET" />
 
     <application><activity
-            android:name=".DownloadActivity"
-            android:exported="true"
-            android:label="@string/play_kml_tour_app_name">
+        android:name=".DownloadActivity"
+        android:exported="true"
+        android:label="@string/play_kml_tour_app_name">
 
-
-            <meta-data
-                android:name="android.app.lib_name"
-                android:value="" />
-        </activity>
+    </activity>
         <activity
             android:name=".MainActivity"
             android:exported="true"

samples/play-kml-tour/src/main/java/com/esri/arcgismaps/sample/playkmltour/DownloadActivity.kt

@@ -1,3 +1,19 @@
+/* Copyright 2024 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.playkmltour
 
 import android.content.Intent

samples/play-kml-tour/src/main/java/com/esri/arcgismaps/sample/playkmltour/MainActivity.kt

@@ -1,4 +1,4 @@
-/* Copyright 2023 Esri
+/* Copyright 2024 Esri
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,233 +17,37 @@
 package com.esri.arcgismaps.sample.playkmltour
 
 import android.os.Bundle
-import android.util.Log
-import androidx.appcompat.app.AppCompatActivity
-import androidx.appcompat.content.res.AppCompatResources
-import androidx.databinding.DataBindingUtil
-import androidx.lifecycle.lifecycleScope
+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.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.ViewpointType
-import com.arcgismaps.mapping.kml.KmlContainer
-import com.arcgismaps.mapping.kml.KmlDataset
-import com.arcgismaps.mapping.kml.KmlNode
-import com.arcgismaps.mapping.kml.KmlTour
-import com.arcgismaps.mapping.kml.KmlTourController
-import com.arcgismaps.mapping.kml.KmlTourStatus
-import com.arcgismaps.mapping.layers.KmlLayer
-import com.esri.arcgismaps.sample.playkmltour.databinding.PlayKmlTourActivityMainBinding
-import com.google.android.material.snackbar.Snackbar
-import kotlinx.coroutines.delay
-import kotlinx.coroutines.launch
-import java.io.File
-import kotlin.math.roundToInt
+import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme
+import com.esri.arcgismaps.sample.playkmltour.screens.PlayKMLTourScreen
 
-
-class MainActivity : AppCompatActivity() {
-
-    private val provisionPath: String by lazy {
-        getExternalFilesDir(null)?.path.toString() + File.separator + getString(R.string.play_kml_tour_app_name)
-    }
-
-    // set up data binding for the activity
-    private val activityMainBinding: PlayKmlTourActivityMainBinding by lazy {
-        DataBindingUtil.setContentView(this, R.layout.play_kml_tour_activity_main)
-    }
-
-    private val sceneView by lazy {
-        activityMainBinding.sceneView
-    }
-
-    private val playPauseButton by lazy {
-        activityMainBinding.playPauseButton
-    }
-
-    private val resetTourButton by lazy {
-        activityMainBinding.resetTourButton
-    }
-
-    private val tourStatusTV by lazy {
-        activityMainBinding.tourStatusTV
-    }
-
-    private val tourProgressBar by lazy {
-        activityMainBinding.tourProgressBar
-    }
-
-    private var initialViewpoint: Viewpoint? = null
-
-    private val kmlTourController = KmlTourController()
+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)
-        lifecycle.addObserver(sceneView)
-
-
-        // add elevation data
-        val surface = Surface().apply {
-            elevationSources.add(ArcGISTiledElevationSource(getString(R.string.world_terrain_service)))
-        }
-
-        // create a scene and set the surface
-        sceneView.scene = ArcGISScene(BasemapStyle.ArcGISImagery).apply {
-            baseSurface = surface
-        }
-
-        // add a KML layer from a KML dataset with a KML tour
-        val kmlDataset = KmlDataset(provisionPath + getString(R.string.kml_tour_path))
-        val kmlLayer = KmlLayer(kmlDataset)
 
-        // add the layer to the scene view's operational layers
-        sceneView.scene?.operationalLayers?.add(kmlLayer)
-
-        // load the KML layer
-        lifecycleScope.launch {
-            kmlLayer.load().onFailure {
-                showError(it.message.toString())
-            }.onSuccess {
-                // get the first loaded KML tour
-                val kmlTour = findFirstKMLTour(kmlDataset.rootNodes)
-                if (kmlTour == null) {
-                    showError("Cannot find KML tour in dataset")
-                    return@onSuccess
-                }
-
-                // collect changes in KML tour status
-                collectKmlTourStatus(kmlTour)
-
-                // set the KML tour to the controller
-                kmlTourController.tour = kmlTour
-            }
-        }
-
-        resetTourButton.setOnClickListener {
-            // set tour to the initial viewpoint
-            initialViewpoint?.let { sceneView.setViewpoint(it) }
-            // reset tour controller
-            kmlTourController.reset()
-        }
-
-        playPauseButton.setOnClickListener {
-            // button was clicked when tour was playing
-            if (kmlTourController.tour?.status?.value == KmlTourStatus.Playing)
-            // pause KML tour
-                kmlTourController.pause()
-            else
-            // play KML tour
-                kmlTourController.play()
-        }
-    }
-
-    /**
-     * Recursively searches for the first KML tour in a list of [kmlNodes].
-     * Returns the first [KmlTour], or null if there are no tours.
-     */
-    private fun findFirstKMLTour(kmlNodes: List<KmlNode>): KmlTour? {
-        kmlNodes.forEach { node ->
-            if (node is KmlTour)
-                return node
-            else if (node is KmlContainer)
-                return findFirstKMLTour(node.childNodes)
-        }
-        return null
-    }
-
-    /**
-     * Collects KmlTourStatus events from the [kmlTour] and then calls
-     * showKmlTourStatus()
-     */
-    private fun collectKmlTourStatus(kmlTour: KmlTour) = lifecycleScope.launch {
-        kmlTour.status.collect { kmlTourStatus ->
-            when (kmlTourStatus) {
-                KmlTourStatus.Completed -> {
-                    showKmlTourStatus("Completed", isResetEnabled = false, isPlayingTour = false)
-                }
-                KmlTourStatus.Initialized -> {
-                    showKmlTourStatus("Initialized", isResetEnabled = false, isPlayingTour = false)
-                }
-                KmlTourStatus.Paused -> {
-                    showKmlTourStatus("Paused", isResetEnabled = true, isPlayingTour = false)
-                }
-                KmlTourStatus.Playing -> {
-                    showKmlTourStatus("Playing", isResetEnabled = true, isPlayingTour = true)
-                    // set the tour's initial viewpoint
-                    if (initialViewpoint == null) {
-                        initialViewpoint = sceneView.getCurrentViewpoint(
-                            ViewpointType.BoundingGeometry
-                        )
-                    }
-                }
-                else -> {}
+        setContent {
+            SampleAppTheme {
+                PlayKMLTourApp()
             }
         }
     }
 
-    /**
-     * Displays the KML tour status using the [kmlTourStatus], display [resetTourButton]
-     * if [isResetEnabled] and set [playPauseButton] based on [isPlayingTour].
-     */
-    private fun showKmlTourStatus(
-        kmlTourStatus: String,
-        isResetEnabled: Boolean,
-        isPlayingTour: Boolean
-    ) {
-        // set the KML tour status
-        tourStatusTV.text = String.format("Tour status: %s", kmlTourStatus)
-
-        // enable the buttons
-        resetTourButton.isEnabled = isResetEnabled
-        playPauseButton.isEnabled = true
-
-        // show pause button if true
-        if (isPlayingTour) {
-            playPauseButton.apply {
-                // set button icon
-                icon = AppCompatResources.getDrawable(
-                    this@MainActivity,
-                    R.drawable.ic_round_pause_24
-                )
-                // set button text
-                text = getText(R.string.pause)
-            }
-        } else { // show play button if false
-            playPauseButton.apply {
-                // set button icon
-                icon = AppCompatResources.getDrawable(
-                    this@MainActivity,
-                    R.drawable.ic_round_play_arrow_24
-                )
-                // set button text
-                text = getString(R.string.play)
-            }
-        }
-
-        // get progress of tour every second
-        lifecycleScope.launch {
-            // run as long as KML tour status is "Playing"
-            while (kmlTourStatus == "Playing") {
-                // get percentage of current position over total duration
-                val tourProgressInt = ((kmlTourController.currentPosition.value * 100.0)
-                        / (kmlTourController.totalDuration.value)).roundToInt()
-                tourProgressBar.progress = tourProgressInt
-                // set a second delay
-                delay(1000)
-            }
+    @Composable
+    private fun PlayKMLTourApp() {
+        Surface(color = MaterialTheme.colorScheme.background) {
+            PlayKMLTourScreen(
+                sampleName = getString(R.string.play_kml_tour_app_name)
+            )
         }
-
-    }
-
-    private fun showError(message: String) {
-        Log.e(localClassName, message)
-        Snackbar.make(sceneView, message, Snackbar.LENGTH_SHORT).show()
     }
 }