Learn how to create and display a scene from a web scene stored in ArcGIS.
This tutorial shows you how to create and display a scene from a web scene. All web scenes are stored in ArcGIS with a unique item ID. You will access an existing web scene by item ID and display its layers. The web scene contains feature layers for the Santa Monica Mountains in California.
TutorialTo learn how to create your own web scene, complete the Create a web scene tutorial.
PrerequisitesBefore starting this tutorial:
You need an ArcGIS Location Platform or ArcGIS Online account.
Ensure your development environment meets the system requirements.
Optionally, you may want to install the ArcGIS Maps SDK for .NET to get access to project templates in Visual Studio (Windows only) and offline copies of the NuGet packages.
Develop or downloadYou have two options for completing this tutorial:
Option 1: Develop the codeTo start the tutorial, complete the Display a scene tutorial. This creates a scene to display an area of the Santa Monica Mountains in a scene view.
Open a Visual Studio solutionThe Visual Studio solution, project, and the namespace for all classes currently use the name DisplayAScene. Follow the steps below if you prefer the name to reflect the current tutorial. These steps are not required, your code will still work if you keep the original name.
The tutorial instructions and code use the name DisplayAWebScene for the solution, project, and namespace. You can choose any name you like, but it should be the same for each of these.
Update the name for the solution and the project.
Rename the namespace used by classes in the project.
SceneViewModel class, double-click the namespace name (DisplayAScene) to select it, and then right-click and choose Rename....Build the project.
You can use ArcGIS tools to create and view web scenes. Use the Scene Viewer to identify the web scene item ID. This item ID will be used later in the tutorial.
You can display a web scene using the web scene's item ID. Create a scene from the web scene portal item, and display it in your app.
In Visual Studio, in the Solution Explorer, double-click SceneViewModel.cs to open the file.
The project uses the Model-View-ViewModel (MVVM) design pattern to separate the application logic (view model) from the user interface (view). SceneViewModel.cs contains the view model class for the application, called SceneViewModel. See the Microsoft documentation for more information about the Model-View-ViewModel pattern.
Add additional required using statements at the top of the class.
SceneViewModel.cs
Use dark colors for code blocks
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
using System;
using System.Collections.Generic;
using System.Text;
using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using System.ComponentModel;
using System.Runtime.CompilerServices;
using Esri.ArcGISRuntime.Portal;
using System.Threading.Tasks;
In the SceneViewModel class, remove all the existing code in the SetupScene() function.
SceneViewModel.cs
Use dark colors for code blocks
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
private void SetupScene()
{
// Create a new scene with an imagery basemap.
Scene scene = new Scene(BasemapStyle.ArcGISImageryStandard);
// Create an elevation source to show relief in the scene.
string elevationServiceUrl = "http://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer";
ArcGISTiledElevationSource elevationSource = new ArcGISTiledElevationSource(new Uri(elevationServiceUrl));
// Create a Surface with the elevation data.
Surface elevationSurface = new Surface();
elevationSurface.ElevationSources.Add(elevationSource);
// Add an exaggeration factor to increase the 3D effect of the elevation.
elevationSurface.ElevationExaggeration = 2.5;
// Apply the surface to the scene.
scene.BaseSurface = elevationSurface;
// Create a point that defines the observer's (camera) initial location in the scene.
// The point defines a longitude, latitude, and altitude of the initial camera location.
MapPoint cameraLocation = new MapPoint(-118.804, 33.909, 5330.0, SpatialReferences.Wgs84);
// Create a Camera using the point, the direction the camera should face (heading), and its pitch and roll (rotation and tilt).
Camera sceneCamera = new Camera(locationPoint: cameraLocation,
heading: 355.0,
pitch: 72.0,
roll: 0.0);
// Create the initial point to center the camera on (the Santa Monica mountains in Southern California).
// Longitude=118.805 degrees West, Latitude=34.027 degrees North
MapPoint sceneCenterPoint = new MapPoint(-118.805, 34.027, SpatialReferences.Wgs84);
// Set an initial viewpoint for the scene using the camera and observation point.
Viewpoint initialViewpoint = new Viewpoint(sceneCenterPoint, sceneCamera);
scene.InitialViewpoint = initialViewpoint;
// Set the view model "Scene" property.
this.Scene = scene;
}
A web scene can define all of the things that are created in this code, such as the basemap, elevation layer, and initial viewpoint. Loading a scene from a web scene usually requires less code, makes it easier to update a scene used by several apps, and can provide a more consistent experience for your user.
Modify the signature of the SetupScene() function to include the async keyword and return Task rather than void.
SceneViewModel.cs
Expand
Use dark colors for code blocks1
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
private async Task SetupScene()
{
}
When calling methods asynchronously inside a function (using the await keyword), the async keyword is required in the signature.
Although a void return type would continue to work, this is not considered best practice. Exceptions thrown by an async void method cannot be caught outside of that method, are difficult to test, and can cause serious side effects if the caller is not expecting them to be asynchronous. The only circumstance where async void is acceptable is when using an event handler, such as a button click.
See the Microsoft documentation for more information about Asynchronous programming with async and await.
Modify the call to SetupScene() (in the SceneViewModel constructor) to avoid a compilation warning. After changing SetupScene() to an asynchronous method, the following warning appears in the Visual Studio Error List.
Use dark colors for code blocks Copy
1
2
Because this call is not awaited, execution of the current method continues before the call is
completed. Consider applying the 'await' operator to the result of the call.Because your code does not anticipate a return value from this call, the warning can be ignored. To be more specific about your intentions with this call and to address the warning, add the following code to store the return value in a discard.
SceneViewModel.cs
Expand
Use dark colors for code blocks1
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
public SceneViewModel()
{
_ = SetupScene();
}
From the Microsoft documentation:
"[Discards] are placeholder variables that are intentionally unused in application code. Discards are equivalent to unassigned variables; they don't have a value. A discard communicates intent to the compiler and others that read your code: You intended to ignore the result of an expression."
Add code to the SetupScene() function to create a PortalItem for the web scene. To do this, provide the web scene's item ID and an ArcGISPortal referencing ArcGIS Online.
SceneViewModel.cs
Expand
Use dark colors for code blocks1
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
private async Task SetupScene()
{
// Create a portal. If a URI is not specified, www.arcgis.com is used by default.
ArcGISPortal portal = await ArcGISPortal.CreateAsync();
// Get the portal item for a web scene using its unique item id.
PortalItem sceneItem = await PortalItem.CreateAsync(portal, "579f97b2f3b94d4a8e48a5f140a6639b");
}
Create a Scene using the PortalItem. To display the scene, set the SceneViewModel.Scene property to this new Scene.
SceneViewModel.cs
Expand
Use dark colors for code blocks1
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
private async Task SetupScene()
{
// Create a portal. If a URI is not specified, www.arcgis.com is used by default.
ArcGISPortal portal = await ArcGISPortal.CreateAsync();
// Get the portal item for a web scene using its unique item id.
PortalItem sceneItem = await PortalItem.CreateAsync(portal, "579f97b2f3b94d4a8e48a5f140a6639b");
// Create the scene from the item.
Scene scene = new Scene(sceneItem);
// To display the scene, set the SceneViewModel.Scene property, which is bound to the scene view.
this.Scene = scene;
}
Click Debug > Start Debugging (or press <F5> on the keyboard) to run the app. If your app uses user authentication, enter your ArcGIS Online credentials when prompted.
If creating apps for Android or iOS, you will need the appropriate emulator, simulator, or device configured for testing (see System requirements for details)
Your app should display the scene that you viewed earlier in the Scene Viewer.
Alternatively, you can download the tutorial solution, as follows.
Option 2: Download the solutionClick the Download solution link in the right-hand panel of the page.
Unzip the file to a location on your machine.
Open the .sln file in Visual Studio.
Since the downloaded solution does not contain authentication credentials, you must first set up authentication to create credentials, and then add the developer credentials to the solution.
Set up authenticationTo access the secure ArcGIS location services used in this tutorial, you must implement API key authentication or user authentication using an ArcGIS Location Platform or an ArcGIS Online account.
You can implement API key authentication or user authentication in this tutorial. Compare the differences below:
API key authentication
Learn more in API key authentication.
User authentication
Learn more in User authentication.
Security and authentication guideTo learn more about the different types of authentication, visit Types of authentication.
Create a new API key access token with privileges to access the secure resources used in this tutorial.
Complete the Create an API key tutorial and create an API key with the following privilege(s):
Copy and paste the API key access token into a safe location. It will be used in a later step.
Create new OAuth credentials to access the secure resources used in this tutorial.
WarningConfiguration steps later in the tutorial will assume that your redirect URL is my-app://auth. If you use a different URL, make sure to configure your app's settings accordingly.
Complete the Create OAuth credentials for user authentication tutorial to obtain a Client ID and Redirect URL.
A Client ID uniquely identifies your app on the authenticating server. If the server cannot find an app with the provided Client ID, it will not proceed with authentication.
The Redirect URL (also referred to as a callback url) is used to identify a response from the authenticating server when the system returns control back to your app after an OAuth login. Since it does not necessarily represent a valid endpoint that a user could navigate to, the redirect URL can use a custom scheme, such as my-app://auth. It is important to make sure the redirect URL used in your app's code matches a redirect URL configured on the authenticating server.
Copy and paste the Client ID and Redirect URL into a safe location. They will be used in a later step.
All users that access this application need account privileges to access the ArcGIS Basemap Styles service.
Set developer credentials in the solutionTo allow your app users to access ArcGIS location services, use the developer credentials that you created in the Set up authentication step to authenticate requests for resources.
In Visual Studio, in the Solution Explorer, click App.xaml.cs to open the file.
Set the ArcGISEnvironment.ApiKey property with your API key access token.
App.xaml.cs
Use dark colors for code blocks
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
protected override void OnStartup(StartupEventArgs e)
{
base.OnStartup(e);
// Set the access token for ArcGIS Maps SDK for .NET.
Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "YOUR_ACCESS_TOKEN";
// Call a function to set up the AuthenticationManager for OAuth.
UserAuth.ArcGISLoginPrompt.SetChallengeHandler();
}
Remove the code that sets up user authentication.
App.xaml.cs
Use dark colors for code blocks
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
protected override void OnStartup(StartupEventArgs e)
{
base.OnStartup(e);
// Set the access token for ArcGIS Maps SDK for .NET.
Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "YOUR_ACCESS_TOKEN";
// Call a function to set up the AuthenticationManager for OAuth.
UserAuth.ArcGISLoginPrompt.SetChallengeHandler();
}
Best Practice: The access token is stored directly in the code as a convenience for this tutorial. Do not store credentials directly in source code in a production environment.
From the Visual Studio Solution explorer window, open the ArcGISLoginPrompt.cs file.
Set your values for the client ID (OAuthClientID) and the redirect URL (OAuthRedirectUrl). These are the user authentication settings you created in the Set up authentication step.
ArcGISLoginPrompt.cs
Use dark colors for code blocks
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
250
251
internal static class ArcGISLoginPrompt
{
private const string ArcGISOnlineUrl = "https://www.arcgis.com/sharing/rest";
// Specify the Client ID and Redirect URL to use with OAuth authentication.
// See the instructions here for creating OAuth app settings:
// https://developers.arcgis.com/documentation/security-and-authentication/user-authentication/tutorials/create-oauth-credentials-user-auth/
private const string AppClientId = "YOUR_CLIENT_ID";
private const string OAuthRedirectUrl = "YOUR_REDIRECT_URL";
In Visual Studio, in the Solution Explorer, click App.xaml.cs to open the file.
Remove the line of code that sets an API key access token.
App.xaml.cs
Use dark colors for code blocks
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
protected override void OnStartup(StartupEventArgs e)
{
base.OnStartup(e);
// Set the access token for ArcGIS Maps SDK for .NET.
Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "YOUR_ACCESS_TOKEN";
// Call a function to set up the AuthenticationManager for OAuth.
UserAuth.ArcGISLoginPrompt.SetChallengeHandler();
}
Best Practice: The OAuth credentials are stored directly in the code as a convenience for this tutorial. Do not store credentials directly in source code in a production environment.
Run the solutionClick Debug > Start Debugging (or press <F5> on the keyboard) to run the app. If your app uses user authentication, enter your ArcGIS Online credentials when prompted.
Your app should display the scene that you viewed earlier in the Scene Viewer.
What's Next?Learn how to use additional API features, ArcGIS location services, and ArcGIS tools in these tutorials:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4