Class MobileScenePackage

  • All Implemented Interfaces:
    Loadable

    public final class MobileScenePackage
    extends Object
    implements Loadable
    A mobile scene package is a transport mechanism for scenes. It contains metadata about the package (description, thumbnail, etc.), one or more scenes, layers, data, and optionally locators. Packages are created in ArcGIS Pro. Mobile scene packages are a major part of the offline workflow. Scenes inside a mobile scene package can be used and programmatically edited (layers can be added or removed). Note, mobile scene packages are read-only; edits to scenes or layers are not persisted to disk.

    MobileScenePackage implements the Loadable interface; the mobile scene package contents can be accessed after the mobile scene package has loaded.

    The mobile scene package has a version property which application developers can use to determine if they can be opened in this version of the ArcGIS Runtime SDK. The ArcGIS Runtime will be backwards compatible back to 1.0 mobile scene packages and will open the latest supported major version, but will not be able to open future major versions of packages. Please see the system requirements for details on what scene package versions are currently supported.

    Example to load an ArcGISScene from a MobileScenePackage into a SceneView:

     scenePackage = new MobileScenePackage("file/path/MyMobileScenePackage.mspk");
     scenePackage.loadAsync();
     scenePackage.addDoneLoadingListener(() -> {
       if (scenePackage.getLoadStatus() == LoadStatus.LOADED) {
         sceneView.setScene(scenePackage.getScenes().get(0));
       }
     });
     
    Since:
    100.5.0
    See Also:
    ArcGISScene
    • Constructor Detail

      • MobileScenePackage

        public MobileScenePackage​(String path)
        Creates a new MobileScenePackage from a file with a .mspk extension or a directory containing an unpacked mobile scene package.
        Parameters:
        path - the path to a .mspk file or a folder containing an unpacked mobile scene package
        Throws:
        IllegalArgumentException - if path is null or empty
        Since:
        100.5.0
    • Method Detail

      • getScenes

        public List<ArcGISScene> getScenes()
        Gets an unmodifiable list of scenes contained in the mobile scene package.
        Returns:
        a list of scenes in the mobile scene package
        Since:
        100.5.0
      • getItem

        public Item getItem()
        Gets the item which provides metadata of the mobile scene package.
        Returns:
        Item
        Since:
        100.5.0
      • getPath

        public String getPath()
        Gets the path to the .mspk file or directory containing the unpacked mobile scene package that this MobileScenePackage was constructed from.
        Returns:
        path to the .mspk file or directory containing the unpacked mobile scene package
        Since:
        100.5.0
        See Also:
        MobileScenePackage(String)
      • getVersion

        public String getVersion()
        Gets the mobile scene package version. It can be used to determine if an app can support the mobile scene package.
        Returns:
        the mobile scene package version
        Since:
        100.5.0
      • getLocatorTask

        public LocatorTask getLocatorTask()
        Gets the locator task if the mobile scene package has one. If a mobile scene package is made in ArcGIS Pro using multiple locator tasks, they will be merged into one in the package. A geocode result from the locator task will contain information about which original locator task it came from.
        Returns:
        the mobile scene package's locator task, or null if the package is not loaded or if no locator is in the package
        Since:
        100.5.0
        See Also:
        LocatorTask
      • getExpiration

        public Expiration getExpiration()
        Gets the expiration details for this mobile scene package, if provided.

        If the mobile scene package was authored with expiration, this property will be populated when the package is loaded or fails to load. If the package has expired and was authored as ExpirationType.PREVENT_EXPIRED_ACCESS then loading will fail and the package can no longer be used.

        Returns:
        the expiration details for this mobile scene package, or null if the package is not loaded or no expiration date has been set
        Since:
        100.5.0
        See Also:
        Expiration
      • close

        public void close()
        Closes a mobile scene package and frees file locks on the underlying .mspk file or directory.

        All references to mobile scene package data (scenes, layers, tables, locators, etc.) should be released before closing the package. If active references to mobile scene package data exist, this method will still close the package, but subsequent rendering and data access methods will fail. Results of accessing mobile scene package data after calling close are undefined.

        After closing a mobile scene package, the underlying .mspk file or directory can be moved or deleted.

        Closing a mobile scene package is not necessary if the package has not been loaded.

        Since:
        100.6.0
        See Also:
        MobileMapPackage.close(), Geodatabase.close()
      • isDirectReadSupportedAsync

        public static ListenableFuture<Boolean> isDirectReadSupportedAsync​(String path)
        Checks if a mobile scene package file (.mspk) contains data or functionality that can be used without unpacking.

        If the package contains data or functionality that can only be used when the package is unpacked, then this will return false. If package doesn't exist or it cannot be read, an error is thrown.

        Parameters:
        path - the path to a .mspk file
        Returns:
        a ListenableFuture. Add a listener to this to know when the result is ready. The result of the future indicates if direct read is supported or not.
        Throws:
        IllegalArgumentException - if path is null or empty
        Since:
        100.5.0
      • unpackAsync

        public static ListenableFuture<Void> unpackAsync​(String path,
                                                         String destinationFolder)
        Unpacks a mobile scene package file (.mspk) to an output directory. Use isDirectReadSupportedAsync(String) to determine if a package can be read without being unpacked. If the last level of the destination directory is not present, it will be created as part of unpacking.

        The returned future can be canceled to abort the unpack. The unpack task writes the full content of the mobile scene package to the output directory. Care should be taken on devices with limited storage space, especially if the original package is very large. After unpacking, you can remove the original .mspk file from the device.

        Parameters:
        path - the path to a .mspk file
        destinationFolder - the folder to place the unpacked .mspk
        Returns:
        a ListenableFuture. Add a listener to this to know when the unpack is done
        Throws:
        IllegalArgumentException - if path is null or empty
        IllegalArgumentException - if destinationFolder is null or empty
        Since:
        100.5.0
      • getLoadStatus

        public LoadStatus getLoadStatus()
        Description copied from interface: Loadable
        Returns the LoadStatus of the loadable resource.
        Specified by:
        getLoadStatus in interface Loadable
        Returns:
        the LoadStatus of the loadable resource
      • getLoadError

        public ArcGISRuntimeException getLoadError()
        Description copied from interface: Loadable
        Returns the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state, either due to calling loadAsync or retryLoadAsync.

        If the resource subsequently transitions to LoadStatus.LOADED, for example if a call to retryLoadAsync completes successfully, the error is cleared out.

        Specified by:
        getLoadError in interface Loadable
        Returns:
        the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state.
      • cancelLoad

        public void cancelLoad()
        Description copied from interface: Loadable
        Cancels a pending load operation.

        A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling this method and the resource will transition from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled a CancellationException will be returned from Loadable.getLoadError().

        Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.

        This method does nothing if the resource is not in LoadStatus.LOADING state.

        Specified by:
        cancelLoad in interface Loadable
      • loadAsync

        public void loadAsync()
        Description copied from interface: Loadable
        Loads the metadata of the loadable resource asynchronously.

        The load status changes from LoadStatus.NOT_LOADED to LoadStatus.LOADING. A listener can be added via Loadable.addDoneLoadingListener(java.lang.Runnable) that is invoked upon completion of the asynchronous load operation.

        If the load operation completes successfully, the load status will be LoadStatus.LOADED, which means the resource has loaded its metadata.

        If the load operation failed, the load status will be LoadStatus.FAILED_TO_LOAD and the error can be retrieved by calling Loadable.getLoadError().

        This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (LoadStatus.LOADING state) when loadAsync is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED or LoadStatus.FAILED_TO_LOAD state) when loadAsync is called, the done loading listener is immediately invoked when added to the loadable resource.

        If a loadable resource has failed to load, calling loadAsync on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource, Loadable.retryLoadAsync() needs to be used.

        A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling Loadable.cancelLoad().

        Specified by:
        loadAsync in interface Loadable
      • retryLoadAsync

        public void retryLoadAsync()
        Description copied from interface: Loadable
        Tries to reload the metadata of the loadable resource asynchronously, but only if the resource failed to load previously (LoadStatus.FAILED_TO_LOAD state) or wasn't loaded to begin with ( LoadStatus.NOT_LOADED state).

        For more details on the load process see Loadable.loadAsync().

        Specified by:
        retryLoadAsync in interface Loadable
      • addDoneLoadingListener

        public void addDoneLoadingListener​(Runnable listener)
        Description copied from interface: Loadable
        Adds a listener to the loadable resource that is invoked when loading has completed.

        The listener may be added at any point, whether the loadable resource has already completed loading or not.

        • For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
        • For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.

        Alternatively, to be notified when there is any change in the load status, use the Loadable.addLoadStatusChangedListener(LoadStatusChangedListener) method instead.

        Specified by:
        addDoneLoadingListener in interface Loadable
        Parameters:
        listener - a Runnable that is invoked upon completion of the load operation
      • removeDoneLoadingListener

        public boolean removeDoneLoadingListener​(Runnable listener)
        Description copied from interface: Loadable
        Removes a done loading listener from the loadable resource.
        Specified by:
        removeDoneLoadingListener in interface Loadable
        Parameters:
        listener - the listener to be removed
        Returns:
        true if the listener was removed, otherwise false
      • addLoadStatusChangedListener

        public void addLoadStatusChangedListener​(LoadStatusChangedListener listener)
        Description copied from interface: Loadable
        Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.

        Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.

        The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the Loadable.addDoneLoadingListener(Runnable) method.

        Specified by:
        addLoadStatusChangedListener in interface Loadable
        Parameters:
        listener - the LoadStatusChangedListener to be added
      • removeLoadStatusChangedListener

        public boolean removeLoadStatusChangedListener​(LoadStatusChangedListener listener)
        Description copied from interface: Loadable
        Removes a LoadStatusChangedListener from the loadable resource.
        Specified by:
        removeLoadStatusChangedListener in interface Loadable
        Parameters:
        listener - the LoadStatusChangedListener to be removed
        Returns:
        true if the listener was removed, otherwise false