Play KML tour

/* 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
import android.os.Bundle
import com.esri.arcgismaps.sample.sampleslib.DownloaderActivity

class DownloadActivity : DownloaderActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        downloadAndStartSample(
            Intent(this, MainActivity::class.java),
            // get the app name of the sample
            getString(R.string.play_kml_tour_app_name),
            listOf(
                // ArcGIS Portal item containing the .kmz markup tour file
                // of Esri HQ and some of the global offices
                "https://arcgisruntime.maps.arcgis.com/home/item.html?id=f10b1d37fdd645c9bc9b189fb546307c"
            )
        )
    }
}

/* 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.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.runtime.Composable
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme
import com.esri.arcgismaps.sample.playkmltour.screens.PlayKmlTourScreen

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)

        enableEdgeToEdge()
        setContent {
            SampleAppTheme {
                PlayKMLTourApp()
            }
        }
    }

    @Composable
    private fun PlayKMLTourApp() {
        Surface(color = MaterialTheme.colorScheme.background) {
            PlayKmlTourScreen(
                sampleName = getString(R.string.play_kml_tour_app_name)
            )
        }
    }
}

/* 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.components

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
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.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.arcgismaps.toolkit.geoviewcompose.SceneViewProxy
import com.esri.arcgismaps.sample.playkmltour.R
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.flow.combine
import kotlinx.coroutines.launch
import java.io.File

class PlayKmlTourViewModel(application: Application) : AndroidViewModel(application) {

    private val provisionPath: String by lazy { application.getExternalFilesDir(null)?.path.toString() +
            File.separator +
            application.getString(R.string.play_kml_tour_app_name)
    }

    // add elevation data
    private val surface = Surface().apply {
        elevationSources.add(ArcGISTiledElevationSource("https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"))
    }

    // create a KML layer from a KML dataset with a KML tour
    private val kmlDataSet = KmlDataset(provisionPath + File.separator + "Esri_tour.kmz")
    private val kmlLayer = KmlLayer(kmlDataSet)

    // create a scene with the surface and KML layer
    val arcGISScene = ArcGISScene(BasemapStyle.ArcGISImagery).apply {
            baseSurface = surface
            initialViewpoint = Viewpoint(39.8, -98.6, 10e7)
            operationalLayers.add(kmlLayer)
        }

    val sceneViewProxy = SceneViewProxy()

    private var kmlTour: KmlTour? = null
    private val kmlTourController = KmlTourController()

    private val _kmlTourStatusFlow: MutableStateFlow<KmlTourStatus> = MutableStateFlow(KmlTourStatus.NotInitialized)
    val kmlTourStatusFlow = _kmlTourStatusFlow.asStateFlow()

    private val _kmlTourProgressFlow: MutableStateFlow<Float> = MutableStateFlow(0.0f)
    val kmlTourProgressFlow = _kmlTourProgressFlow.asStateFlow()

    // Create a message dialog view model for handling error messages
    val messageDialogVM = MessageDialogViewModel()

    init {
        viewModelScope.launch {
            arcGISScene.load().onFailure { error ->
                messageDialogVM.showMessageDialog(
                    "Failed to load scene",
                    error.message.toString()
                )
            }
            kmlLayer.load().onSuccess {
                findFirstKMLTour(kmlDataSet.rootNodes)?.let {
                    kmlTour = it
                    collectKmlTourStatus(it)
                    kmlTourController.tour = it
                    collectProgress(kmlTourController)
                }
            }.onFailure { error ->
                messageDialogVM.showMessageDialog(
                    "Failed to load KML tour",
                    error.message.toString()
                )
            }
        }
    }

    /**
     * Plays or pauses the KML tour
     */
    fun playOrPause() {
        kmlTour?.let {
            when (it.status.value) {
                KmlTourStatus.Playing -> kmlTourController.pause()
                KmlTourStatus.Paused, KmlTourStatus.Initialized, KmlTourStatus.Completed -> kmlTourController.play()
                else -> throw IllegalStateException("KML tour is not initialized")
            }
        }
    }

    /**
     * Resets the tour
     */
    fun reset() {
        kmlTourController.reset()
        arcGISScene.initialViewpoint?.let { sceneViewProxy.setViewpoint(it) }
    }

    /**
     * Collects the progress of the KML tour and puts it into a state flow
     */
    private fun collectProgress(kmlTourController: KmlTourController) = viewModelScope.launch {
        kmlTourController.currentPosition.combine(kmlTourController.totalDuration) { currentPosition, totalDuration ->
            (currentPosition / totalDuration).toFloat()
        }.collect { progress -> _kmlTourProgressFlow.value = progress }
    }

    /**
     * Collects the status of the KML tour and puts it into a state flow
     */
    private fun collectKmlTourStatus(kmlTour: KmlTour) = viewModelScope.launch {
        kmlTour.status.collect { state -> _kmlTourStatusFlow.value = state }
    }

    /**
     * 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
    }
}

/* 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.screens

import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Button
import androidx.compose.material3.Icon
import androidx.compose.material3.LinearProgressIndicator
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.mapping.kml.KmlTourStatus
import com.arcgismaps.toolkit.geoviewcompose.SceneView
import com.esri.arcgismaps.sample.playkmltour.R
import com.esri.arcgismaps.sample.playkmltour.components.PlayKmlTourViewModel
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialog
import com.esri.arcgismaps.sample.sampleslib.components.SampleTopAppBar

/**
 * Main screen layout for the sample
 */
@Composable
fun PlayKmlTourScreen(sampleName: String) {
    val viewModel: PlayKmlTourViewModel = viewModel()

    val kmlTourStatus by viewModel.kmlTourStatusFlow.collectAsStateWithLifecycle()
    val kmlTourProgress by viewModel.kmlTourProgressFlow.collectAsStateWithLifecycle()

    Scaffold(
        topBar = { SampleTopAppBar(title = sampleName) },
        content = {
            Column(
                modifier = Modifier
                    .fillMaxSize()
                    .padding(it),
            ) {
                SceneView(
                    modifier = Modifier
                        .fillMaxSize()
                        .weight(1f),
                    isAttributionBarVisible = false,
                    arcGISScene = viewModel.arcGISScene,
                    sceneViewProxy = viewModel.sceneViewProxy
                )

                val padding = 8.dp

                LinearProgressIndicator(progress = { kmlTourProgress },
                    modifier = Modifier
                        .fillMaxWidth()
                        .padding(all = padding))
                Text("${stringResource(R.string.tour_status)} ${tourStateToString(kmlTourStatus)}",
                    modifier = Modifier
                        .padding(all = padding)
                        .align(Alignment.CenterHorizontally))
                Row(modifier = Modifier.fillMaxWidth()) {
                    Button(enabled = (kmlTourStatus == KmlTourStatus.Paused || kmlTourStatus == KmlTourStatus.Playing),
                        modifier = Modifier
                            .fillMaxWidth(0.5f)
                            .padding(all = padding),
                        onClick = {
                            viewModel.reset()
                        }) {
                        Icon(
                            painter = painterResource(id = R.drawable.ic_baseline_reset_24),
                            contentDescription = null
                        )
                        Text(stringResource(R.string.reset))
                    }
                    Button(enabled = (kmlTourStatus != KmlTourStatus.NotInitialized),
                        modifier = Modifier
                        .fillMaxWidth()
                        .padding(all = padding),
                        onClick = {
                            // play tour
                            viewModel.playOrPause()
                        }) {
                        if (kmlTourStatus == KmlTourStatus.Playing) {
                            Icon(
                                painter = painterResource(id = R.drawable.ic_round_pause_24),
                                contentDescription = null
                            )
                            Text(stringResource(R.string.pause))
                        } else {
                            Icon(
                                painter = painterResource(id = R.drawable.ic_round_play_arrow_24),
                                contentDescription = null
                            )
                            Text(stringResource(R.string.play))
                        }
                    }
                }
            }

            viewModel.messageDialogVM.apply {
                if (dialogStatus) {
                    MessageDialog(
                        title = messageTitle,
                        description = messageDescription,
                        onDismissRequest = ::dismissDialog
                    )
                }
            }
        }
    )
}

private fun tourStateToString(tourStatus: KmlTourStatus) : String {
    return when (tourStatus) {
        KmlTourStatus.Paused -> "Paused"
        KmlTourStatus.Playing -> "Playing"
        KmlTourStatus.Completed -> "Completed"
        KmlTourStatus.Initializing -> "Initializing"
        KmlTourStatus.Initialized -> "Initialized"
        KmlTourStatus.NotInitialized -> "Not Initialized"
    }
}