MobileScenePackage class final

A mobile scene package.

Mobile scene packages allow you to work with 3D scenes on a mobile device. A mobile scene package contains all of the files necessary to work with your scenes and is stored on a device as either:

  • A single archive file with an .mspk extension
  • A directory containing an unpacked mobile scene package

A mobile scene package can encapsulate one or more scenes, their layers and data, transportation networks, and a locator. The mobile scene package also contains an Item with metadata about the package (description, thumbnail, etc.). You can use these packages to share scenes across ArcGIS products and to allow your users to work with scenes in the field. Mobile scene packages also allow you to continue working when you have limited or no connectivity.

Starting with ArcGIS Pro 2.3 you can create mobile scene packages for use by this API. Mobile scene packages are supported up to major version 3.

Mobile scene packages can contain links to online services, but be aware that these services will be unavailable if your device is offline. You can choose whether to use:

Online services (such as traffic or weather) can provide excellent contextual information for your users. If the mobile scene package is going to be used in areas of poor connectivity, however, you must ensure that data critical to your workflow is stored locally on the device.

Mobile scene packages implement the Loadable interface; you need to load the MobileScenePackage before you can access its content. Once loaded you can:

  • Determine the version of this package using the MobileScenePackage.version property. This API supports mobile scene packages up to and including major version 3. If the package is from an unsupported version it will fail to load.
  • Discover whether the package has expired using the MobileScenePackage.expiration property
  • Access the individual scenes and display them in an ArcGISSceneViewController
  • Programmatically add, modify, and remove layers in the scene. Mobile scene packages, however, are read-only and these changes to scenes or layers will not be persisted to the device.
Implemented types
Mixed-in types

Constructors

MobileScenePackage.withFileUri(Uri fileUri)
Create a MobileScenePackage with a path.
factory

Properties

expiration Expiration?
Expiration details for this mobile scene package, if provided.
no setter
fileUri Uri
The path to the mobile scene package.
no setter
hashCode int
The hash code for this object.
no setterinherited
item Item?
The mobile scene package's Item describing metadata about the package.
no setter
loadError ArcGISException?
The load error.
no setterinherited
loadStatus LoadStatus
The load status.
no setterinherited
locatorTask LocatorTask?
A LocatorTask from the mobile scene package.
no setter
onLoadStatusChanged Stream<LoadStatus>
A stream that reports changes to the LoadStatus.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scenes List<ArcGISScene>
A collection of ArcGISScene from the MobileScenePackage.
no setter
version String
The mobile scene package's version.
no setter

Methods

cancelLoad() → void
Cancels loading metadata for the object.
inherited
close() → void
Closes a mobile scene package.
load() Future<void>
Loads the metadata for the object asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
retryLoad() Future<void>
Loads or retries loading metadata for the object asynchronously.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

unpack({required Uri mobileScenePackageFileUri, required Uri outputDirectory}) Future<void>
Unpacks a mobile scene package file (.mspk) to an output directory.