Opens and displays a scene from a Mobile Scene Package (.mspk).
Use case
An .mspk file is an archive containing the data (specifically, basemaps and features), used to display an offline 3D scene.
How to use the sample
When the sample opens, it will automatically display the Scene in the Mobile Map Package.
How it works
- Create a
MobileScenePackage
using the path to the local .mspk file. - Use
MobileScenePackage.IsDirectReadSupportedAsync
to check whether the package can be read in the archived form (.mspk) or whether it needs to be unpacked. - If the mobile scene package requires unpacking, call
MobileScenePackage.UnpackAsync
. - Call
MobileScenePackage.Load
. - When the
MobileScenePackage
is loaded, obtain the firstScene
from theScenes
property. - Display the scene in a SceneView.
Relevant API
- MobileScenePackage
- SceneView
Offline data
The following items will be downloaded from ArcGIS Online automatically:
- Philadelphia MSPK - Philadelphia mobile scene package authored in ArcGIS Pro
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
// 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 Android.App;
using Android.OS;
using Android.Views;
using Android.Widget;
using ArcGISRuntime.Samples.Managers;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.UI.Controls;
using System;
using System.Linq;
using Debug = System.Diagnostics.Debug;
namespace ArcGISRuntimeXamarin.Samples.OpenMobileScenePackage
{
[Activity(ConfigurationChanges = Android.Content.PM.ConfigChanges.Orientation | Android.Content.PM.ConfigChanges.ScreenSize)]
[ArcGISRuntime.Samples.Shared.Attributes.Sample(
name: "Open mobile scene package",
category: "Scene",
description: "Opens and displays a scene from a Mobile Scene Package (.mspk).",
instructions: "When the sample opens, it will automatically display the Scene in the Mobile Map Package.",
tags: new[] { "offline", "scene" })]
[ArcGISRuntime.Samples.Shared.Attributes.OfflineData("7dd2f97bb007466ea939160d0de96a9d")]
public class OpenMobileScenePackage : Activity
{
// Hold references to the UI control.
private SceneView _mySceneView;
protected override void OnCreate(Bundle bundle)
{
base.OnCreate(bundle);
Title = "Open mobile scene package";
CreateLayout();
Initialize();
}
private async void Initialize()
{
// Get the path to the scene package.
string scenePath = DataManager.GetDataFolder("7dd2f97bb007466ea939160d0de96a9d", "philadelphia.mspk");
try
{
// Open the package.
MobileScenePackage package = await MobileScenePackage.OpenAsync(scenePath);
// Load the package.
await package.LoadAsync();
// Show the first scene.
_mySceneView.Scene = package.Scenes.First();
}
catch (Exception e)
{
new AlertDialog.Builder(this).SetMessage(e.Message).SetTitle("Couldn't open scene").Show();
Debug.WriteLine(e);
}
}
private void CreateLayout()
{
// Create a new vertical layout for the app.
var layout = new LinearLayout(this) { Orientation = Orientation.Vertical };
// Add the scene view to the layout.
_mySceneView = new SceneView(this);
layout.AddView(_mySceneView);
// Show the layout in the app.
SetContentView(layout);
}
protected override void OnDestroy()
{
base.OnDestroy();
// Remove the sceneview
(_mySceneView.Parent as ViewGroup).RemoveView(_mySceneView);
_mySceneView.Dispose();
_mySceneView = null;
}
}
}