Set surface placement mode

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/* Copyright 2025 Esri
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.esri.arcgismaps.sample.setsurfaceplacementmode.components

import android.app.Application
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableDoubleStateOf
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.setValue
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.Color
import com.arcgismaps.geometry.GeometryEngine
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.layers.ArcGISSceneLayer
import com.arcgismaps.mapping.view.Camera
import com.arcgismaps.mapping.view.Graphic
import com.arcgismaps.mapping.view.GraphicsOverlay
import com.arcgismaps.mapping.view.SurfacePlacement
import com.arcgismaps.mapping.symbology.HorizontalAlignment
import com.arcgismaps.mapping.symbology.SimpleMarkerSymbol
import com.arcgismaps.mapping.symbology.SimpleMarkerSymbolStyle
import com.arcgismaps.mapping.symbology.TextSymbol
import com.arcgismaps.mapping.symbology.VerticalAlignment
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.launch

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

    private val arcGISSceneLayerUrl =
        "https://tiles.arcgis.com/tiles/P3ePLMYs2RVChkJx/arcgis/rest/services/Buildings_Brest/SceneServer"
    private val elevationSourceUrl =
        "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"

    // Z-value range used for interactive elevation updates
    val zMin = 0.0
    val zMax = 140.0
    val zMid = (zMin + zMax) / 2.0

    // Create ArcGISScene
    val arcGISScene: ArcGISScene = ArcGISScene(BasemapStyle.ArcGISImagery).apply {
        // Add elevation to the base surface
        baseSurface = Surface().apply {
            elevationSources.add(ArcGISTiledElevationSource(elevationSourceUrl))
        }
        // Add scene layer from a URL
        operationalLayers.add(ArcGISSceneLayer(uri = arcGISSceneLayerUrl))

        // Set an initial viewpoint
        val viewpointPoint = Point(
            x = -4.4595,
            y = 48.3889,
            z = 80.0,
            spatialReference = SpatialReference.wgs84()
        )
        val camera = Camera(
            locationPoint = viewpointPoint,
            heading = 330.0,
            pitch = 97.0,
            roll = 0.0
        )
        initialViewpoint = Viewpoint(
            boundingGeometry = viewpointPoint,
            camera = camera
        )
    }

    // Graphics overlays for each surface placement mode
    private val overlayAbsolute = createGraphicsOverlay(
        surfacePlacement = SurfacePlacement.Absolute,
        label = "Absolute",
        offset = 0.0
    )
    private val overlayDrapedBillboarded = createGraphicsOverlay(
        surfacePlacement = SurfacePlacement.DrapedBillboarded,
        label = "Draped Billboarded",
        offset = 0.0
    )
    private val overlayDrapedFlat = createGraphicsOverlay(
        surfacePlacement = SurfacePlacement.DrapedFlat,
        label = "Draped Flat",
        offset = 0.0
    )
    private val overlayRelative = createGraphicsOverlay(
        surfacePlacement = SurfacePlacement.Relative,
        label = "Relative",
        offset = 0.0
    )
    private val overlayRelativeToScene = createGraphicsOverlay(
        surfacePlacement = SurfacePlacement.RelativeToScene,
        label = "Relative to Scene",
        // Tiny X/Y offset helps differentiate symbols rendered at the same location
        offset = 2e-4
    )

    // Expose overlays as a list for the SceneView composable
    val graphicsOverlays: List<GraphicsOverlay> = listOf(
        overlayAbsolute,
        overlayDrapedBillboarded,
        overlayDrapedFlat,
        overlayRelative,
        overlayRelativeToScene
    )

    // Current draped mode selection
    var drapedMode by mutableStateOf(DrapedMode.Billboarded)
        private set

    // Current Z-value in meters used by all graphics
    var zValue by mutableDoubleStateOf(zMid)
        private set

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

    init {
        // Set initial draped overlay visibility
        updateDrapedOverlayVisibility(DrapedMode.Billboarded)
        // Load the scene and handle any errors
        viewModelScope.launch {
            arcGISScene.load().onFailure { messageDialogVM.showMessageDialog(it) }
        }
    }

    // Update currently selected draped mode and toggle visibility
    fun updateDrapedMode(mode: DrapedMode) {
        drapedMode = mode
        updateDrapedOverlayVisibility(mode)
    }

    // Update the Z-value (in meters) applied to all placement graphics
    fun updateZValue(valueMeters: Float) {
        val newZ = valueMeters.toDouble()
        zValue = newZ
        updateGraphicsZValue(newZ)
    }

    // Toggle visibility between DrapedBillboarded and DrapedFlat overlays
    private fun updateDrapedOverlayVisibility(mode: DrapedMode) {
        overlayDrapedBillboarded.isVisible = mode == DrapedMode.Billboarded
        overlayDrapedFlat.isVisible = mode == DrapedMode.Flat
    }

    // Apply the given Z-value to all graphics
    private fun updateGraphicsZValue(zMeters: Double) {
        graphicsOverlays.forEach { overlay ->
            overlay.graphics.forEach { graphic ->
                graphic.geometry?.let { geometry ->
                    graphic.geometry = GeometryEngine.createWithZ(geometry, zMeters)
                }
            }
        }
    }

    // Create a GraphicsOverlay with a marker and label configured for the given SurfacePlacement
    private fun createGraphicsOverlay(
        surfacePlacement: SurfacePlacement,
        label: String,
        offset: Double
    ): GraphicsOverlay {
        // Simple red triangle marker
        val markerSymbol = SimpleMarkerSymbol(
            style = SimpleMarkerSymbolStyle.Triangle,
            color = Color.red,
            size = 20f
        )
        // Blue text label with cyan halo for readability
        val textSymbol = TextSymbol(
            text = label,
            color = Color.fromRgba(0, 0, 255, 255),
            size = 20f,
            horizontalAlignment = HorizontalAlignment.Left,
            verticalAlignment = VerticalAlignment.Middle
        ).apply {
            haloColor = Color.cyan
            haloWidth = 2f
            // Vertical offset avoids overlapping label and marker
            offsetY = 20f
        }

        // apply tiny XY offset when requested to avoid overlap
        val point = Point(
            x = -4.4609257 + offset,
            y = 48.3903965 + offset,
            z = zMid,
            spatialReference = SpatialReference.wgs84()
        )

        // Create overlay with both graphics and set its placement behavior
        return GraphicsOverlay().apply {
            graphics.addAll(
                listOf(
                    Graphic(geometry = point, symbol = markerSymbol),
                    Graphic(geometry = point, symbol = textSymbol)
                )
            )
            sceneProperties.surfacePlacement = surfacePlacement
        }
    }

    enum class DrapedMode { Billboarded, Flat }
}