Skip To Content ArcGIS for Developers Sign In Dashboard

ImageOverlay Class

(Esri::ArcGISRuntime::ImageOverlay)

An overlay that contains a frame with an image to display in the view. More...

Header: #include <ImageOverlay>
Since: Esri::ArcGISRuntime 100.8
Inherits: Object

Public Functions

ImageOverlay(QObject *parent = nullptr)
ImageOverlay(ImageFrame *imageFrame, QObject *parent = nullptr)
~ImageOverlay()
Envelope extent() const
ImageFrame *imageFrame() const
bool isVisible() const
float opacity() const
void setImageFrame(ImageFrame *imageFrame)
void setOpacity(float opacity)
void setVisible(bool visible)
  • 31 public functions inherited from QObject

Additional Inherited Members

Detailed Description

An overlay that contains a frame with an image to display in the view.

The overlay can contain exactly one image at any given time, however, multiple overlays can be added and rendered at the same time on the SceneView.

ImageOverlay can be used to render fast and dynamic images. One example of such usage can be rendering of realtime sensor data like weather radar data, where each individual static image represents a single frame from the radar. In this workflow the 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 becomes available.

ImageOverlay does not support the rich processing and rendering capabilities of a RasterLayer. Use Raster and RasterLayer for static image rendering, analysis, and persistence.

Currently this feature is supported in SceneView (3D) only.

See also ImageFrame and SceneView.

Member Function Documentation

ImageOverlay::ImageOverlay(QObject *parent = nullptr)

Constructs an empty ImageOverlay object using an optional parent.

ImageOverlay::ImageOverlay(ImageFrame *imageFrame, QObject *parent = nullptr)

Constructs an ImageOverlay object that contains an imageFrame and an optional parent.

ImageOverlay::~ImageOverlay()

Destructor.

Envelope ImageOverlay::extent() const

Returns the extent of the ImageOverlay.

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

ImageFrame *ImageOverlay::imageFrame() const

Returns the ImageFrame contained in the ImageOverlay.

See also setImageFrame().

bool ImageOverlay::isVisible() const

Returns the visibility of the ImageOverlay.

float ImageOverlay::opacity() const

Returns 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.

See also setOpacity().

void ImageOverlay::setImageFrame(ImageFrame *imageFrame)

See also imageFrame().

void ImageOverlay::setOpacity(float opacity)

Sets the opacity to the opacity value specified.

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

See also opacity().

void ImageOverlay::setVisible(bool visible)

Sets whether the visibility is visible to visible

See also isVisible().


Feedback on this topic?