Filter features in scene

View on GitHub

Filter 3D scene features out of a given geometry with a polygon filter.

Image of filter features in scene sample

Use case

You can directly control what users see within a specific scene view to give a more focused or cleaner user experience by using a SceneLayerPolygonFilter to selectively show or hide scene features within a given area.

How to use the sample

The sample initializes showing the 3D buildings OpenStreetMap layer. Tap the "Add Buildings" button to load an additional scene layer that contains more detailed buildings. Notice how the two scene layers overlap and clip into each other. Tap the "Filter" button to set a SceneLayerPolygonFilter and filter out the OpenStreetMap buildings within the extent of the detailed buildings scene. Notice how the OSM buildings within and intersecting the extent of the detailed buildings layer are hidden. Tap the "Reset" button to hide the detailed buildings scene layer and clear the OSM buildings filter.

How it works

  1. Construct a Basemap for the scene using a topographic ArcGISVectorTileLayer and the OpenStreetMap 3D Buildings ArcGISSceneLayer as baselayers.
  2. Create a Surface for the scene and set the World Elevation 3D as an elevation source.
  3. Add the 3D San Francisco Buildings ArcGISSceneLayer to the scene's operational layers.
  4. Construct a SceneLayerPolygonFilter with the extent of the San Francisco Buildings Scene Layer and the SceneLayerPolygonFilter.SpatialRelationship.disjoint enum to hide all features within the extent.
  5. Set the SceneLayerPolygonFilter on the OSM Buildings layer to hide all OSM buildings within the extent of the San Francisco Buildings layer.

Relevant API

  • ArcGISSceneLayer
  • SceneLayerPolygonFilter
  • SceneLayerPolygonFilter.SpatialRelationship

About the data

This sample uses the OpenStreetMap 3D Buildings which provides generic 3D outlines of buildings throughout the world. It is based on the OSM Daylight map distribution and is hosted by Esri. It uses the San Francisco 3D Buildings scene layer which provides detailed 3D models of buildings in San Francisco, California, USA.

Additional information

This sample uses SceneLayerPolygonFilter.SpatialRelationship.disjoint to hide all features within the extent of the given geometry. You can alternatively use SceneLayerPolygonFilter.SpatialRelationship.contains to only show features within the extent of the geometry.

You can also show or hide features in a scene layer using ArcGISSceneLayer.setVisible(_:for:) and pass in a feature or a list of features and a boolean value to set their visibility.

Tags

3D, buildings, disjoint, exclude, extent, filter, hide, OSM, polygon

Sample Code

FilterFeaturesInSceneView.swift
Use dark colors for code blocksCopy
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
// Copyright 2023 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 ArcGIS
import SwiftUI

struct FilterFeaturesInSceneView: View {
    /// The view model for this sample.
    @StateObject private var model = Model()

    /// The error shown in the error alert.
    @State private var error: Error?

    var body: some View {
        SceneView(scene: model.scene, graphicsOverlays: [model.graphicsOverlay])
            .task {
                do {
                    try await model.scene.load()
                } catch {
                    self.error = error
                }
            }
            .toolbar {
                ToolbarItemGroup(placement: .bottomBar) {
                    Button(model.filterState.label) {
                        model.handleFilterState()
                    }
                }
            }
            .errorAlert(presentingError: $error)
    }
}

private extension FilterFeaturesInSceneView {
    /// The model used to store the geo model and other expensive objects
    /// used in this view.
    @MainActor
    class Model: ObservableObject {
        /// The scene for this sample.
        let scene: ArcGIS.Scene

        /// The open street map layer for the sample.
        private let osmBuildings = ArcGISSceneLayer(
            item: PortalItem(
                portal: .arcGISOnline(connection: .anonymous),
                id: .osmBuildings
            )
        )

        /// The San Francisco buildings scene layer for the sample.
        private let buildingsSceneLayer = ArcGISSceneLayer(
            url: URL(string: "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/SanFrancisco_Bldgs/SceneServer")!
        )

        /// The graphics overlay for the scene view.
        let graphicsOverlay = GraphicsOverlay()

        /// A polygon that shows the extent of the detailed buildings scene layer.
        private let polygon: ArcGIS.Polygon = makeFilteringPolygon()

        /// A red extent boundary graphic that represents the full extent of the detailed buildings scene layer.
        private let sanFranciscoExtentGraphic: Graphic

        /// The filter state for the scene view.
        @Published private(set) var filterState: FilterState = .addBuildings

        init() {
            // Create basemap.
            let vectorTiledLayer = ArcGISVectorTiledLayer(
                item: PortalItem(
                    portal: .arcGISOnline(connection: .anonymous),
                    id: .osmTopographic
                )
            )
            scene = Scene(basemap: Basemap(baseLayers: [vectorTiledLayer, osmBuildings]))

            // Create scene topography.
            let elevationServiceURL = URL(string: "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer")!
            let elevationSource = ArcGISTiledElevationSource(url: elevationServiceURL)
            let surface = Surface()
            surface.addElevationSource(elevationSource)
            scene.baseSurface = surface

            // Set the initial viewpoint of the scene.
            scene.initialViewpoint = .sanFranciscoBuildings

            let simpleFillSymbol = SimpleFillSymbol(
                style: .solid,
                color: .clear,
                outline: SimpleLineSymbol(
                    style: .solid,
                    color: .red,
                    width: 5
                )
            )

            sanFranciscoExtentGraphic = Graphic(
                geometry: polygon,
                symbol: simpleFillSymbol
            )
        }

        /// Creates a polygon that represents the detailed buildings scene layer full extent.
        /// - Returns: A polygon.
        private static func makeFilteringPolygon() -> ArcGIS.Polygon {
            // The buildings scene layer fullExtent.
            let extent = Envelope(
                xRange: -122.514 ... -122.357,
                yRange: 37.705...37.831,
                zRange: -148.843...551.801,
                spatialReference: SpatialReference(wkid: .wgs84, verticalWKID: WKID(5773)!)
            )

            let builder = PolygonBuilder(spatialReference: extent.spatialReference)
            builder.add(Point(x: extent.xMin, y: extent.yMin))
            builder.add(Point(x: extent.xMax, y: extent.yMin))
            builder.add(Point(x: extent.xMax, y: extent.yMax))
            builder.add(Point(x: extent.xMin, y: extent.yMax))

            return builder.toGeometry()
        }

        /// Handles the filter state of the sample by either loading, filtering, or reseting the scene.
        func handleFilterState() {
            switch filterState {
            case .addBuildings:
                // Show the detailed buildings scene layer and extent graphic.
                addBuildings()
            case .filter:
                // Hide buildings within the detailed building extent so they don't clip.
                filterScene()
            case .reset:
                // Reset the scene to its original state.
                resetScene()
            }

            // Set the next filter state to be applied to the scene.
            filterState = filterState.next()
        }

        /// Loads the detailed buildings scene layer and adds an extent graphic.
        private func addBuildings() {
            scene.addOperationalLayer(buildingsSceneLayer)
            graphicsOverlay.addGraphic(sanFranciscoExtentGraphic)
        }

        /// Applies a polygon filter to the open street map buildings layer.
        private func filterScene() {
            if let polygonFilter = osmBuildings.polygonFilter {
                // After the scene is reset, the layer will have a polygon filter, but that filter
                // will not have polygons set.
                // Add the polygon back to the polygon filter.
                polygonFilter.addPolygon(polygon)
            } else {
                // Initially, the building layer does not have a polygon filter, set it.
                osmBuildings.polygonFilter = SceneLayerPolygonFilter(
                    polygons: [polygon],
                    spatialRelationship: .disjoint
                )
            }
        }

        /// Resets the scene filters and hides the detailed buildings and extent graphic.
        private func resetScene() {
            // Remove the detailed buildings layer from the scene.
            scene.removeAllOperationalLayers()
            // Clear OSM buildings polygon filter.
            osmBuildings.polygonFilter?.removeAllPolygons()
            // Remove red extent boundary graphic from graphics overlay.
            graphicsOverlay.removeAllGraphics()
        }
    }

    /// The different states for filtering features in a scene.
    enum FilterState: Equatable {
        case addBuildings, filter, reset

        /// A human-readable label for the filter state.
        var label: String {
            switch self {
            case .addBuildings: return "Add Buildings"
            case .filter: return "Filter"
            case .reset: return "Reset"
            }
        }

        /// The next filter state to apply to a scene.
        func next() -> Self {
            switch self {
            case .addBuildings:
                return .filter
            case .filter:
                return .reset
            case .reset:
                return .addBuildings
            }
        }
    }
}

private extension PortalItem.ID {
    /// The ID used in the "OpenStreetMap 3D Buildings" portal item.
    static var osmBuildings: Self { Self("ca0470dbbddb4db28bad74ed39949e25")! }
    /// The ID used in the "OpenStreetMap Topographic (for 3D)" portal item.
    static var osmTopographic: Self { Self("1e7d1784d1ef4b79ba6764d0bd6c3150")! }
}

private extension Viewpoint {
    /// The initial viewpoint to be displayed when the sample is first opened.
    static let sanFranciscoBuildings = Viewpoint(
        latitude: .nan,
        longitude: .nan,
        scale: .nan,
        camera: Camera(
            location: Point(
                x: -122.421,
                y: 37.7041,
                z: 207
            ),
            heading: 60,
            pitch: 70,
            roll: 0
        )
    )
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.