Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for .NET

Open Mobile Scene Package

This code sample is available for these platforms:
View Sample on GitHub

Open and display a scene from a Mobile Scene Package (.mspk).

Image

How to use the sample

When the sample opens, it will automatically display the Scene in the Mobile Map Package.

How it works

  1. Create a MobileScenePackage using the path to the local .mspk file.
  2. Use MobileScenePackage.IsDirectReadSupportedAsync to check whether the package can be read in the archived form (.mspk) or whether it needs to be unpacked.
  3. If the mobile scene package requires unpacking, call MobileScenePackage.UnpackAsync.
  4. Call MobileScenePackage.Load.
  5. When the MobileScenePackage is loaded, obtain the first Scene from the Scenes property.
  6. Display the scene in a SceneView.

Relevant API

  • MobileScenePackage
  • SceneView

Offline data

The following items will be downloaded from ArcGIS Online automatically:

About the data

This mobile scene package was authored with ArcGIS Pro.

Additional information

An .mspk file is an archive containing the data used to display an offline 3D scene. Some mobile scene packages have data that must be unpacked before reading.

Tags

Offline, Scene

Sample Code

<UserControl 
    x:Class="ArcGISRuntime.UWP.Samples.OpenMobileScenePackage.OpenMobileScenePackage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:esri="using:Esri.ArcGISRuntime"
    xmlns:esriUI="using:Esri.ArcGISRuntime.UI.Controls">
    <Grid>
        <esriUI:SceneView x:Name="MySceneView" />
    </Grid>
</UserControl>
// Copyright 2019 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.

using ArcGISRuntime.Samples.Managers;
using Esri.ArcGISRuntime.Mapping;
using System;
using System.Diagnostics;
using System.Linq;
using Windows.UI.Popups;

namespace ArcGISRuntime.UWP.Samples.OpenMobileScenePackage
{
    [ArcGISRuntime.Samples.Shared.Attributes.Sample(
        "Open mobile scene package",
        "Map",
        "Display a scene from an offline mobile scene package (.mspk).",
        "")]
    [ArcGISRuntime.Samples.Shared.Attributes.OfflineData("7dd2f97bb007466ea939160d0de96a9d")]
    public partial class OpenMobileScenePackage
    {
        public OpenMobileScenePackage()
        {
            InitializeComponent();
            Initialize();
        }

        private async void Initialize()
        {
            // Get the path to the scene package.
            string scenePath = DataManager.GetDataFolder("7dd2f97bb007466ea939160d0de96a9d", "philadelphia.mspk");

            try
            {
                // Determine if the package can be read directly or needs to be unpacked.
                if (await MobileScenePackage.IsDirectReadSupportedAsync(scenePath))
                {
                    // Open the package.
                    MobileScenePackage package = await MobileScenePackage.OpenAsync(scenePath);

                    // Load the package.
                    await package.LoadAsync();

                    // Show the first scene.
                    MySceneView.Scene = package.Scenes.First();
                }
                else
                {
                    // Create a path for the unpacked package.
                    string unpackedPath = scenePath + "unpacked";

                    // Unpack the package.
                    await MobileScenePackage.UnpackAsync(scenePath, unpackedPath);

                    // Open the package.
                    MobileScenePackage package = await MobileScenePackage.OpenAsync(unpackedPath);

                    // Load the package.
                    await package.LoadAsync();

                    // Show the first scene.
                    MySceneView.Scene = package.Scenes.First();
                }
            }
            catch (Exception e)
            {
                await new MessageDialog(e.Message, "Couldn't open scene").ShowAsync();
                Debug.WriteLine(e);
            }
        }
    }
}