Filter features in scene

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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
// 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
//
//   https://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.
//

import 'package:arcgis_maps/arcgis_maps.dart';
import 'package:arcgis_maps_sdk_flutter_samples/common/common.dart';
import 'package:flutter/material.dart';

class FilterFeaturesInScene extends StatefulWidget {
  const FilterFeaturesInScene({super.key});

  @override
  State<FilterFeaturesInScene> createState() => _FilterFeaturesInSceneState();
}

class _FilterFeaturesInSceneState extends State<FilterFeaturesInScene>
    with SampleStateSupport {
  // Create a controller for the scene view.
  final _sceneViewController = ArcGISSceneView.createController();
  // A flag for when the scene view is ready.
  var _ready = false;

  // URLs to the services used in the sample.
  final _basemapUrl =
      'https://arcgisruntime.maps.arcgis.com/home/item.html?id=00a5f468dda941d7bf0b51c144aae3f0';
  final _elevationServiceUrl =
      'https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer';
  final _detailedBuildingsLayerUrl =
      'https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/SanFrancisco_Bldgs/SceneServer';

  // The scene layer containing detailed buildings in San Francisco, CA, USA.
  late ArcGISSceneLayer _detailedBuildingsLayer;
  // The "Buildings" scene layer from the scene's basemap.
  late ArcGISSceneLayer _buildingsLayer;

  // A graphic of the extent of the detailed San Francisco buildings scene layer.
  var _sfExtentGraphic = Graphic();
  // A filter that limits the visible features of the scene layer.
  late SceneLayerPolygonFilter _sceneLayerPolygonFilter;
  // A state for filtering features in a scene.
  var _sceneFilterAction = SceneFilterAction.filter;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: SafeArea(
        top: false,
        left: false,
        right: false,
        child: Stack(
          children: [
            Column(
              children: [
                Expanded(
                  // Add a scene view to the widget tree and set a controller.
                  child: ArcGISSceneView(
                    controllerProvider: () => _sceneViewController,
                    onSceneViewReady: onSceneViewReady,
                  ),
                ),
                Center(
                  // A button to control the state of the filter.
                  child: ElevatedButton(
                    onPressed: onSceneActionPressed,
                    child: Text(_sceneFilterAction.label),
                  ),
                ),
              ],
            ),
            // Display a progress indicator and prevent interaction until state is ready.
            LoadingIndicator(visible: !_ready),
          ],
        ),
      ),
    );
  }

  Future<void> onSceneViewReady() async {
    // Configure the scene and add to the scene view controller.
    final scene = await _setupScene();
    _sceneViewController.arcGISScene = scene;

    // Create a scene layer for the San Francisco buildings.
    _detailedBuildingsLayer = ArcGISSceneLayer.withUri(
      Uri.parse(_detailedBuildingsLayerUrl),
    );
    // Load so that the extent can be accessed.
    await _detailedBuildingsLayer.load();

    // Add the detailed buildings layer to the scene.
    // The layer is initially hidden so that it doesn't
    // clip into the buildings layer while it is unfiltered.
    _detailedBuildingsLayer.isVisible = false;
    _sceneViewController.arcGISScene!.operationalLayers.add(
      _detailedBuildingsLayer,
    );

    // Prepare the scene layer filter.
    _configureSceneLayerFilter();

    // Set the viewpoint over San Francisco.
    final camera = Camera.withLocation(
      location: ArcGISPoint(x: -122.421, y: 37.7041, z: 207),
      heading: 60,
      pitch: 70,
      roll: 0,
    );
    _sceneViewController.setViewpointCamera(camera);

    // Set the ready state variable to true to enable the sample UI.
    setState(() => _ready = true);
  }

  Future<ArcGISScene> _setupScene() async {
    // Create a basemap with the ArcGIS Navigation 3D Basemap.
    final basemap = Basemap.withUri(Uri.parse(_basemapUrl))!;

    // Load the basemap to access the base layers.
    await basemap.load();

    // Get the "Buildings" layer from the base layers.
    _buildingsLayer =
        basemap.baseLayers.where((layer) => layer.name == 'Buildings').first
            as ArcGISSceneLayer;

    // Create a scene with the basemap.
    final scene = ArcGISScene.withBasemap(basemap);

    // Construct and set the scene topography.
    final worldElevationService = Uri.parse(_elevationServiceUrl);
    final elevationSource = ArcGISTiledElevationSource.withUri(
      worldElevationService,
    );
    scene.baseSurface.elevationSources.add(elevationSource);

    return scene;
  }

  // Builds a polygon from the San Francisco buildings extent,
  // adds a red outline graphic, and sets up a filter.
  void _configureSceneLayerFilter() {
    // Build a polygon from the full extent of the San Francisco detailed buildings layer.
    final polygonBuilder = PolygonBuilder(
      spatialReference: _sceneViewController.spatialReference,
    );
    final extent = _detailedBuildingsLayer.fullExtent!;
    polygonBuilder.addPointXY(x: extent.xMin, y: extent.yMin);
    polygonBuilder.addPointXY(x: extent.xMax, y: extent.yMin);
    polygonBuilder.addPointXY(x: extent.xMax, y: extent.yMax);
    polygonBuilder.addPointXY(x: extent.xMin, y: extent.yMax);
    // Convert the polygon builder to a polygon geometry.
    final polygon = polygonBuilder.toGeometry() as Polygon;

    // Create a red outline symbol with transparent fill.
    final outlineSymbol = SimpleFillSymbol(
      color: Colors.transparent,
      outline: SimpleLineSymbol(color: Colors.red, width: 5),
    );

    // Create a graphic using the polygon geometry and symbol.
    _sfExtentGraphic = Graphic(geometry: polygon, symbol: outlineSymbol);

    // Create a graphics overlay and add to the scene view.
    final graphicsOverlay = GraphicsOverlay();
    // Add the graphics overlay to the scene view controller.
    _sceneViewController.graphicsOverlays.add(graphicsOverlay);

    // Initially hide the graphic, since the filter has not been applied yet.
    _sfExtentGraphic.isVisible = false;
    // Add the graphic to the graphics overlay.
    graphicsOverlay.graphics.add(_sfExtentGraphic);

    // Create the SceneLayerPolygonFilter to later apply to the buildings base layer.
    _sceneLayerPolygonFilter = SceneLayerPolygonFilter(
      polygons: [polygon],
      spatialRelationship: SceneLayerPolygonFilterSpatialRelationship.disjoint,
    );
  }

  // Filter scene based on the current filter action.
  void onSceneActionPressed() {
    switch (_sceneFilterAction) {
      case SceneFilterAction.show:
        _showDetailedBuildings();
      case SceneFilterAction.filter:
        _filterScene();
      case SceneFilterAction.reset:
        _resetScene();
    }
    setState(() => _sceneFilterAction = _sceneFilterAction.next());
  }

  // Show the detailed buildings layer.
  void _showDetailedBuildings() {
    _detailedBuildingsLayer.isVisible = true;
  }

  // Apply a polygon filter to hide the 3D buildings in the base layer within the San Francisco detailed buildings layer extent.
  void _filterScene() {
    // Set the polygon filter to the buildings layer.
    _buildingsLayer.polygonFilter = _sceneLayerPolygonFilter;
    // Show the graphic to indicate the filtered extent.
    _sfExtentGraphic.isVisible = true;
  }

  // Reset the scene.
  void _resetScene() {
    // Hide the detailed buildings layer.
    _detailedBuildingsLayer.isVisible = false;
    // Remove the polygon filter from the buildings layer.
    _buildingsLayer.polygonFilter = null;
    // Hide the red extent boundary graphic.
    _sfExtentGraphic.isVisible = false;
  }
}

// The different states for filtering features in the sample workflow.
enum SceneFilterAction {
  show('Show detailed buildings'),
  filter('Filter'),
  reset('Reset scene');

  const SceneFilterAction(this.label);

  final String label;

  // The next action to apply to the scene.
  SceneFilterAction next() {
    switch (this) {
      case SceneFilterAction.filter:
        return SceneFilterAction.show;
      case SceneFilterAction.show:
        return SceneFilterAction.reset;
      case SceneFilterAction.reset:
        return SceneFilterAction.filter;
    }
  }
}