Package com.esri.arcgisruntime.mapping.view

Class ImageFrame

  • All Implemented Interfaces:
    RemoteResource, Loadable
    public final class ImageFrame
extends Object
implements Loadable, RemoteResource
    A frame that, when added to an ImageOverlay, renders an image on top of a scene.

    An ImageFrame can contain images that do not have georeferencing information. In such cases, location data can be provided to geolocate the image.

    Since:
    100.8.0
    See Also:
    ImageOverlay

    • Constructor Detail

      • ImageFrame

        public ImageFrame​(Image image,
                  Envelope extent)
        Creates an ImageFrame containing the image for display at the specified geographic extent.

        If a spatial reference is not defined for the extent, it is assumed to be the same as the scene. If the spatial reference of the extent is different from that of the scene, then the image would fail to render. Supported image formats are TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG.

        Parameters:
        image - an image to display in the frame
        extent - the geographic extent at which the image is displayed
        Throws:
        IllegalArgumentException - if image is null
        IllegalArgumentException - if extent is null
        Since:
        100.8.0

      • ImageFrame

        public ImageFrame​(Image image,
                  Polygon quadrilateral)
        Creates an ImageFrame using the image and a four-point polygon representing the corners of an image.

        If a spatial reference is not defined for the polygon, it is assumed to be the same as the scene. If the spatial reference of the extent is different from that of the scene, then the image would fail to render. If the provided polygon doesn't contain exactly four points, the image frame will fail to load. Supported image formats are TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG.

        Parameters:
        image - an image to display in the frame
        quadrilateral - a polygon consisting of four points that represent each corner of the image
        Throws:
        IllegalArgumentException - if image is null
        IllegalArgumentException - if quadrilateral is null
        Since:
        100.8.0

      • ImageFrame

        public ImageFrame​(String uri)
        Creates an ImageFrame containing the image defined by the provided URI.

        Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URI can be a local file path or an HTTP path to an image.

        Parameters:
        uri - a URI that identifies a local or online image source
        Throws:
        IllegalArgumentException - if uri is null or empty
        Since:
        100.8.0

      • ImageFrame

        public ImageFrame​(String uri,
                  Envelope extent)
        Creates an ImageFrame containing the image identified by the URI for display at the specified geographic extent.

        If a spatial reference is not defined for the extent, it is assumed to be the same as the scene. If the spatial reference of the extent is different from that of the scene, then the image would fail to render. Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URI can be a local file path or an HTTP path to an image.

        Parameters:
        uri - a URI that identifies a local or online image source
        extent - the geographic extent at which the image is displayed
        Throws:
        IllegalArgumentException - if uri is null or empty
        IllegalArgumentException - if extent is null
        Since:
        100.8.0

      • ImageFrame

        public ImageFrame​(String uri,
                  Polygon quadrilateral)
        Creates an ImageFrame using the URI of an image and a four-point polygon representing the corners of an image.

        If a spatial reference is not defined for the polygon, it is assumed to be the same as the scene. If the spatial reference of the extent is different from that of the scene, then the image would fail to render. If the provided polygon doesn't contain exactly four points, the image frame will fail to load. Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URL can be a local file path or an HTTP path to an image.

        Parameters:
        uri - a URI that identifies a local or online image source
        quadrilateral - a polygon consisting of four points that represent each corner of the image
        Throws:
        IllegalArgumentException - if uri is null or empty
        IllegalArgumentException - if quadrilateral is null
        Since:
        100.8.0

    • Method Detail

      • getExtent

        public Envelope getExtent()
        Gets the extent of the image.
        Returns:
        the extent of the image, or null if none
        Since:
        100.8.0

      • getImage

        public Image getImage()
        Gets the image contained in the ImageFrame.
        Returns:
        the image contained in the ImageFrame, or null if none
        Since:
        100.8.0

      • getUri

        public String getUri()
        Gets the URI of the image as a String.
        Specified by:
        getUri in interface RemoteResource
        Returns:
        the URI of the image or empty if not set
        Since:
        100.8.0

      • getQuadrilateral

        public Polygon getQuadrilateral()
        Gets a Polygon consisting of four points that represent each corner of the image.
        Returns:
        a Polygon consisting of four points that represent each corner of the image or null if none
        Since:
        100.8.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

      • cancelLoad

        public void cancelLoad()
        Description copied from interface: Loadable
        Cancels loading metadata for the object.

        Cancels loading the metadata if the object is loading, and always invokes the done loading listener.

        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
        Loads or retries loading metadata for the object asynchronously.

        Will retry loading the metadata if the object's load status is LoadStatus.FAILED_TO_LOAD. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

        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

      • getCredential

        public Credential getCredential()
        Description copied from interface: RemoteResource
        Gets the Credential that is set on the network-enabled resource.

        Only applicable if the resource is secured.

        Specified by:
        getCredential in interface RemoteResource
        Returns:
        the Credential, or null if there is none

      • setCredential

        public void setCredential​(Credential credential)
        Description copied from interface: RemoteResource
        Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.

        Only applicable if the resource is secured.

        Specified by:
        setCredential in interface RemoteResource
        Parameters:
        credential - the Credential to be used for authentication