Skip to content

Commit

Permalink
disable map rotation, handle reset state and other PR fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@TADraeseke
TADraeseke committed Feb 5, 2025
1 parent 348494a commit 5108b75
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 62 deletions.
2 changes: 1 addition & 1 deletion samples/generate-offline-map-with-custom-parameters/src/main/AndroidManifest.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<application><activity
android:exported="true"
android:name=".MainActivity"
android:label="@string/display_composable_map_view_app_name">
android:label="@string/generate_offline_map_with_custom_parameters_app_name">

</activity>
</application>
Expand Down
152 changes: 95 additions & 57 deletions ...linemapwithcustomparameters/components/GenerateOfflineMapWithCustomParametersViewModel.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ import com.arcgismaps.geometry.GeometryEngine
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.mapping.layers.FeatureLayer
import com.arcgismaps.mapping.layers.Layer
import com.arcgismaps.mapping.symbology.SimpleLineSymbol
import com.arcgismaps.mapping.symbology.SimpleLineSymbolStyle
import com.arcgismaps.mapping.view.Graphic
Expand All @@ -46,8 +45,8 @@ import com.arcgismaps.tasks.offlinemaptask.GenerateOfflineMapParameterOverrides
import com.arcgismaps.tasks.offlinemaptask.GenerateOfflineMapParameters
import com.arcgismaps.tasks.offlinemaptask.OfflineMapParametersKey
import com.arcgismaps.tasks.offlinemaptask.OfflineMapTask
import com.arcgismaps.tasks.tilecache.ExportTileCacheParameters
import com.arcgismaps.toolkit.geoviewcompose.MapViewProxy
import com.esri.arcgismaps.sample.generateofflinemapwithcustomparameters.R
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
Expand All @@ -57,24 +56,27 @@ import java.io.File
class GenerateOfflineMapWithCustomParametersViewModel(private val application: Application) :
AndroidViewModel(application) {

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

val mapViewProxy = MapViewProxy()

// view model to handle popup dialogs
// View model to handle popup dialogs
val messageDialogVM = MessageDialogViewModel()

// create a portal item with the itemId of the web map
var portal: Portal = Portal("https://www.arcgis.com")
var portalItem: PortalItem = PortalItem(portal, "acc027394bc84c2fb04d1ed317aac674")

// create a map with the portal item
var arcGISMap: ArcGISMap = ArcGISMap(portalItem)
// Define map that returns an ArcGISMap
var arcGISMap = ArcGISMap()
private set

// define the download area graphic
// Define the download area graphic
private val downloadAreaGraphic = Graphic().apply {
symbol = SimpleLineSymbol(SimpleLineSymbolStyle.Solid, Color.red, 2f)
}

// create a graphics overlay for the map view
// Create a graphics overlay for the map view
val graphicsOverlay = GraphicsOverlay().apply {
graphics.add(downloadAreaGraphic)
}
Expand All @@ -90,6 +92,9 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
var offlineMapJobProgress by mutableIntStateOf(0)
private set

var showResetButton by mutableStateOf(false)
private set

private var generateOfflineMapJob: GenerateOfflineMapJob? = null

// Create an IntSize to retrieve dimensions of the map
Expand All @@ -99,6 +104,10 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
mapViewSize = size
}

init {
setUpMap()
}

/**
* Use map view's size to determine dimensions of the map to get the download offline area
* and use [MapViewProxy] to assist in converting screen points to map points
Expand All @@ -108,8 +117,7 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
val minScreenPoint = ScreenCoordinate(200.0, 200.0)
// Lower right corner of the downloaded area
val maxScreenPoint = ScreenCoordinate(
x = mapViewSize.width - 200.0,
y = mapViewSize.height - 200.0
x = mapViewSize.width - 200.0, y = mapViewSize.height - 200.0
)
// Convert screen points to map points
val minPoint = mapViewProxy.screenToLocationOrNull(minScreenPoint)
Expand All @@ -122,16 +130,43 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
}

/**
* Define the [GenerateOfflineMapParameterOverrides] for the offline map job with the given parameters.
* Sets up a portal item and displays map area to take offline
*/
private fun setUpMap() {

// Create a portal item with the itemId of the web map
val portal = Portal("https://www.arcgis.com")
val portalItem = PortalItem(portal, "acc027394bc84c2fb04d1ed317aac674")

// Clear, then add the download graphic to the graphics overlay
graphicsOverlay.graphics.clear()
graphicsOverlay.graphics.add(downloadAreaGraphic)

arcGISMap = ArcGISMap(portalItem)
viewModelScope.launch(Dispatchers.Main) {
arcGISMap.load()
.onFailure {
messageDialogVM.showMessageDialog(
title = it.message.toString()
)

}
}
showResetButton = false
}

/**
* Define the [GenerateOfflineMapParameters] for the offline map job and add the custom
* [GenerateOfflineMapParameterOverrides] using the given override values.
*/
fun defineParameters(
fun defineGenerateOfflineMapParameters(
minScale: Int,
maxScale: Int,
bufferDistance: Int,
includeSystemValves: Boolean,
includeServiceConnections: Boolean,
flowRate: Int,
cropWaterPipes: Boolean
isIncludeSystemValvesEnabled: Boolean,
isIncludeServiceConnectionsEnabled: Boolean,
minHydrantFlowRate: Int,
isCropWaterPipesEnabled: Boolean
) {
// Create an offline map offlineMapTask with the map
val offlineMapTask = OfflineMapTask(arcGISMap)
Expand All @@ -148,16 +183,18 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
// Set basemap scale and area of interest
setBasemapScaleAndAreaOfInterest(parameterOverrides, minScale, maxScale, bufferDistance)
// Exclude system valve layer
if (!includeSystemValves) {
if (!isIncludeSystemValvesEnabled) {
excludeLayerFromDownload(parameterOverrides, "System Valve")
}
// Exclude service connection layer
if (!includeServiceConnections) {
if (!isIncludeServiceConnectionsEnabled) {
excludeLayerFromDownload(parameterOverrides, "Service Connection")
}
// Crop pipes layer
if (cropWaterPipes) {
getGenerateGeodatabaseParameters(parameterOverrides, "Main")?.layerOptions?.forEach {
if (isCropWaterPipesEnabled) {
getGenerateGeodatabaseParameters(
parameterOverrides, "Main"
)?.layerOptions?.forEach {
it.useGeometry = true
}
}
Expand All @@ -167,10 +204,9 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
val serviceLayerId =
(hydrantLayer.featureTable as? ServiceFeatureTable)?.layerInfo?.serviceLayerId
getGenerateGeodatabaseParameters(
parameterOverrides,
hydrantLayer.name
parameterOverrides, hydrantLayer.name
)?.layerOptions?.filter { it.layerId == serviceLayerId }?.forEach {
it.whereClause = "FLOW >= $flowRate"
it.whereClause = "FLOW >= $minHydrantFlowRate"
it.queryOption = GenerateLayerQueryOption.UseFilter
}
}
Expand All @@ -192,7 +228,7 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
parameterOverrides: GenerateOfflineMapParameterOverrides
) {
// Store the offline map in the app's scoped storage directory
val offlineMapPath = application.getExternalFilesDir(null)?.path + File.separator + "offlineMap"
val offlineMapPath = provisionPath + File.separator + "OfflineMap"

// Delete any offline map already present
File(offlineMapPath).deleteRecursively()
Expand All @@ -201,8 +237,7 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
viewModelScope.launch(Dispatchers.Main) {
offlineMapTask.load().onFailure { error ->
messageDialogVM.showMessageDialog(
title = error.message.toString(),
description = error.cause.toString()
title = error.message.toString(), description = error.cause.toString()
)
}
}
Expand Down Expand Up @@ -239,15 +274,15 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
offlineMapJob.result().onSuccess {
// Set the offline map result as the displayed map and clear the red bounding box graphic
arcGISMap = it.offlineMap
showResetButton = true
graphicsOverlay.graphics.clear()
// Dismiss the progress dialog
showJobProgressDialog = false
// Show user where map was locally saved
snackbarHostState.showSnackbar(message = "Map saved at: " + offlineMapJob.downloadDirectoryPath)
}.onFailure { throwable ->
messageDialogVM.showMessageDialog(
title = throwable.message.toString(),
description = throwable.cause.toString()
title = throwable.message.toString(), description = throwable.cause.toString()
)
showJobProgressDialog = false
}
Expand All @@ -274,21 +309,26 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
* Set basemap scale and area of interest using the given values
*/
private fun setBasemapScaleAndAreaOfInterest(
parameterOverrides: GenerateOfflineMapParameterOverrides, minScale: Int, maxScale: Int, bufferDistance: Int
parameterOverrides: GenerateOfflineMapParameterOverrides,
minScale: Int,
maxScale: Int,
bufferDistance: Int
) {
// Get the first basemap layer
(arcGISMap.basemap.value?.baseLayers?.first())?.let { basemapLayer ->
// get the export tile cache parameters
getExportTileCacheParameters(parameterOverrides, basemapLayer as? Layer)?.let { exportTileCacheParameters ->
// create a new sublist of LODs in the range requested by the user
exportTileCacheParameters.levelIds.clear()
(minScale until maxScale).forEach { i ->
exportTileCacheParameters.levelIds.add(i)
}
downloadAreaGraphic.geometry?.let { downloadArea ->
// set the area of interest to the original download area plus a buffer
exportTileCacheParameters.areaOfInterest =
GeometryEngine.bufferOrNull(downloadArea, bufferDistance.toDouble())
}
// Use the basemap layer to make an offline map parameters key
val key = OfflineMapParametersKey(basemapLayer)
// Create export tile cache parameters
val exportTileCacheParameters = parameterOverrides.exportTileCacheParameters[key]
// Create a new sublist of LODs in the range requested by the user
exportTileCacheParameters?.levelIds?.clear()
(minScale until maxScale).forEach { i ->
exportTileCacheParameters?.levelIds?.add(i)
}
downloadAreaGraphic.geometry?.let { downloadArea ->
// set the area of interest to the original download area plus a buffer
exportTileCacheParameters?.areaOfInterest =
GeometryEngine.bufferOrNull(downloadArea, bufferDistance.toDouble())
}
}
}
Expand Down Expand Up @@ -316,24 +356,12 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
return (featureLayer.featureTable as? ServiceFeatureTable)?.layerInfo?.serviceLayerId
}

/**
* Helper function to get export tile cache parameters for the given layer.
*/
private fun getExportTileCacheParameters(parameterOverrides: GenerateOfflineMapParameterOverrides, layer: Layer?): ExportTileCacheParameters? {
layer?.let {
val key = OfflineMapParametersKey(it)
return parameterOverrides.exportTileCacheParameters[key]
}
return null
}

/**
* Helper function to get the generate geodatabase parameters for the given layer.
*
*/
private fun getGenerateGeodatabaseParameters(
parameterOverrides: GenerateOfflineMapParameterOverrides,
layerName: String
parameterOverrides: GenerateOfflineMapParameterOverrides, layerName: String
): GenerateGeodatabaseParameters? {
// get the named feature layer
(arcGISMap.operationalLayers.find { it.name == layerName } as? FeatureLayer)?.let { targetFeatureLayer ->
Expand All @@ -343,4 +371,14 @@ class GenerateOfflineMapWithCustomParametersViewModel(private val application: A
}
return null
}

/**
* Clear the preview map and set up mapView again
*/
fun reset() {
// Add the download graphic to the graphics overlay
graphicsOverlay.graphics.clear()
// Set up the portal item to take offline
setUpMap()
}
}
26 changes: 22 additions & 4 deletions ...ateofflinemapwithcustomparameters/screens/GenerateOfflineMapWithCustomParametersScreen.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package com.esri.arcgismaps.sample.generateofflinemapwithcustomparameters.screens

import androidx.compose.foundation.background
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
Expand Down Expand Up @@ -53,6 +54,7 @@ import androidx.compose.ui.layout.onSizeChanged
import androidx.compose.ui.unit.dp
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.LoadStatus
import com.arcgismaps.mapping.view.MapViewInteractionOptions
import com.arcgismaps.toolkit.geoviewcompose.MapView
import com.esri.arcgismaps.sample.generateofflinemapwithcustomparameters.components.GenerateOfflineMapWithCustomParametersViewModel
import com.esri.arcgismaps.sample.sampleslib.components.JobLoadingDialog
Expand All @@ -68,21 +70,28 @@ fun GenerateOfflineMapWithCustomParametersScreen(sampleName: String) {
// Create a ViewModel to handle MapView interactions
val mapViewModel: GenerateOfflineMapWithCustomParametersViewModel = viewModel()

val interactionOptions = remember { MapViewInteractionOptions().apply {
isRotateEnabled = false
} }

// Set up the bottom sheet controls
var showBottomSheet by remember { mutableStateOf(false) }
fun setBottomSheetVisibility(isVisible: Boolean) {
showBottomSheet = isVisible
}

val sheetState = rememberModalBottomSheetState(skipPartiallyExpanded = true)

val showResetButton by remember { mutableStateOf(mapViewModel.showResetButton) }

Scaffold(snackbarHost = { SnackbarHost(hostState = mapViewModel.snackbarHostState) },
topBar = { SampleTopAppBar(title = sampleName) },
content = {
Column(
modifier = Modifier
.fillMaxSize()
.padding(it)
// Disable taps when job progress dialog is shown
.clickable(enabled = !mapViewModel.showJobProgressDialog, onClick = { })
) {
MapView(modifier = Modifier
.weight(1f)
Expand All @@ -93,6 +102,7 @@ fun GenerateOfflineMapWithCustomParametersScreen(sampleName: String) {
},
arcGISMap = mapViewModel.arcGISMap,
graphicsOverlays = listOf(mapViewModel.graphicsOverlay),
mapViewInteractionOptions = interactionOptions,
mapViewProxy = mapViewModel.mapViewProxy,
onLayerViewStateChanged = {
// On launch, ensure the map is loaded before calculating the download area
Expand All @@ -116,7 +126,7 @@ fun GenerateOfflineMapWithCustomParametersScreen(sampleName: String) {
showBottomSheet = false
}, sheetState = sheetState
) {
OverrideParameters(mapViewModel::defineParameters, ::setBottomSheetVisibility)
OverrideParameters(mapViewModel::defineGenerateOfflineMapParameters, ::setBottomSheetVisibility)
}
}
// Display progress dialog while generating an offline map
Expand All @@ -134,12 +144,20 @@ fun GenerateOfflineMapWithCustomParametersScreen(sampleName: String) {
)
}
}

if (mapViewModel.showResetButton) {
Button(
onClick = {
mapViewModel.reset()
}, modifier = Modifier.align(Alignment.CenterHorizontally)
) {
Text("Reset to online map")
}
}
}
},
// Floating action button to show the parameter overrides bottom sheet
floatingActionButton = {
if (!showBottomSheet) {
if (!showBottomSheet && !mapViewModel.showResetButton) {
FloatingActionButton(modifier = Modifier.padding(bottom = 36.dp, end = 12.dp),
onClick = { showBottomSheet = true }) {
Icon(
Expand Down

0 comments on commit 5108b75

Please sign in to comment.