Package com.esri.arcgisruntime.mapping.view

Class ImageOverlay

  • public final class ImageOverlay
extends java.lang.Object
    An overlay that contains a frame with an image to display in the view.

    Currently, this feature is supported in a SceneView (3D) only. The overlay can contain exactly one image at any given time. Multiple overlays, however, can be added and rendered at the same time on the SceneView. An ImageOverlay can be used to quickly render frequently changing images. For example, rendering realtime sensor data, such as weather, where each static image represents a single frame from the radar. In this workflow, images are constantly updated via a new ImageFrame each time new data is available. This provides a fast-refreshing workflow where the underlying images are frequently updated as new data comes in.

    Since ImageOverlay does not support the rich processing and rendering capabilities of a RasterLayer , you should use Raster and RasterLayer for workflows that require static image rendering, analysis, and persistence.

    Image overlays are rendered above all other layers in the scene, draped on the surface, and below any graphics overlays in the scene view.

    Since:
    100.8.0
    See Also:
    ImageFrame, SceneView

    • Constructor Summary

      Constructors 
      Constructor Description
      ImageOverlay()
      Creates an ImageOverlay.
      ImageOverlay​(ImageFrame imageFrame)
      Creates an ImageOverlay that contains an ImageFrame.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Envelope getExtent()
      Gets the extent of the ImageOverlay.
      ImageFrame getImageFrame()
      Gets the ImageFrame that contains the image.
      float getOpacity()
      Gets the opacity of the ImageOverlay.
      boolean isVisible()
      Gets the visibility of the ImageOverlay.
      void setImageFrame​(ImageFrame imageFrame)
      Sets the ImageFrame to be used in the ImageOverlay
      void setOpacity​(float opacity)
      Sets the opacity of the ImageOverlay.
      void setVisible​(boolean isVisible)
      Sets the visibility of the ImageOverlay.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ImageOverlay

        public ImageOverlay()
        Creates an ImageOverlay.
        Since:
        100.8.0

      • ImageOverlay

        public ImageOverlay​(ImageFrame imageFrame)
        Creates an ImageOverlay that contains an ImageFrame.
        Parameters:
        imageFrame - the ImageFrame of the ImageOverlay
        Throws:
        java.lang.IllegalArgumentException - when imageFrame is null
        Since:
        100.8.0

    • Method Detail

      • getImageFrame

        public ImageFrame getImageFrame()
        Gets the ImageFrame that contains the image.
        Returns:
        the ImageFrame contained in the ImageOverlay or null if none
        Since:
        100.8.0

      • setImageFrame

        public void setImageFrame​(ImageFrame imageFrame)
        Sets the ImageFrame to be used in the ImageOverlay
        Parameters:
        imageFrame - the ImageFrame contained in the ImageOverlay
        Since:
        100.8.0

      • getExtent

        public Envelope getExtent()
        Gets the extent of the ImageOverlay.

        The spatial reference of the extent matches the extent of the SceneView that contains the image overlay.

        Returns:
        the extent of the ImageOverlay or null if none
        Since:
        100.8.0

      • isVisible

        public boolean isVisible()
        Gets the visibility of the ImageOverlay.
        Returns:
        the visibility of the ImageOverlay
        Since:
        100.8.0

      • setVisible

        public void setVisible​(boolean isVisible)
        Sets the visibility of the ImageOverlay.
        Parameters:
        isVisible - true if image should be visible
        Since:
        100.8.0

      • getOpacity

        public float getOpacity()
        Gets the opacity of the ImageOverlay.

        Opacity values range from 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.

        Returns:
        the opacity for the ImageOverlay
        Since:
        100.8.0

      • setOpacity

        public void setOpacity​(float opacity)
        Sets the opacity of the ImageOverlay.

        Opacity values range from 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.

        Parameters:
        opacity - the opacity for the ImageOverlay
        Since:
        100.8.0