Display a web scene

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.

Prerequisites

Steps

Open the Visual Studio solution

1. To start the tutorial, complete the Display a scene tutorial or download and unzip the solution.

2. Open the .sln file in Visual Studio.

3. If you downloaded the solution project, set your API key.

   Instructions for setting the API key

   An API Key enables access to services, web maps, and web scenes hosted in ArcGIS Online.

   If necessary, set the API Key.

   1. Go to your developer dashboard to get your API key. For these tutorials, use your default API key. It is scoped to include all of the services demonstrated in the tutorials.

   2. In Visual Studio, in the Solution Explorer, click App.xaml.cs.

   3. In the App class, add an override for the OnStartup() function to set the ApiKey property on ArcGISRuntimeEnvironment.

      App.xaml.cs

      Use dark colors for code blocks

                                              

      Add line.Add line.Add line.Add line.Add line.Add line.Add line.

      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
          public partial class App : Application
          {
      
              protected override void OnStartup(StartupEventArgs e)
              {
                  base.OnStartup(e);
                  // Note: it is not best practice to store API keys in source code.
                  // The API key is referenced here for the convenience of this tutorial.
                  Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "YOUR_API_KEY";
              }
      
          }
      }

Update the tutorial name used in the project (optional)

The 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.

Get the web scene item ID

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.

1. Go to the LA Trails and Parks web scene in the Scene Viewer in ArcGIS Online. This web scene displays trails, trailheads and parks in the Santa Monica Mountains.
2. Make a note of the item ID at the end of the browser's URL. The item ID should be 579f97b2f3b94d4a8e48a5f140a6639b

Display the web scene

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.

1. In Visual Studio, in the Solution Explorer, double-click SceneViewModel.cs to open the file.

1. Add additional required using statements at the top of the class.

   SceneViewModel.cs

   Use dark colors for code blocks

                                                                              

   Add line.Add line.

   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;
   

2. In the SceneViewModel class, remove all the existing code in the SetupScene() function.

   SceneViewModel.cs

   Use dark colors for code blocks

                                                                                                   

   Remove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove lineRemove line

   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;
   
           }
   
   More info

   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.

3. 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 blocks

                                                                              

   Change lineChange line

   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
           private async Task SetupScene()
           {
   
           }
   

   Expand
   More info

   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.

4. 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 blocksCopy

     

   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 blocks

                                                                              

   Change line

   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
           public SceneViewModel()
           {
   
               _ = SetupScene();
   
           }
   

   Expand
   More info

   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."

5. 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 blocks

                                                                              

   Add line.Add line.Add line.Add line.Add line.

   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
           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");
   
           }
   

   Expand
   More info

   ArcGISPortal.CreateAsync() is a static method that returns a new instance of the ArcGISPortal class.

6. 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 blocks

                                                                              

   Add line.Add line.Add line.Add line.

   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
           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;
   
           }
   

   Expand

7. Click Debug > Start Debugging (or press <F5> on the keyboard) to run the app.

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:

• Display a web map
• Display an offline map (on-demand)