ArcGIS Developers

ImageOverlay Class

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: Esri::ArcGISRuntime::Object

This class was introduced in Esri::ArcGISRuntime 100.8.

Public Functions

ImageOverlay(Esri::ArcGISRuntime::ImageFrame *imageFrame, QObject *parent = nullptr)
ImageOverlay(QObject *parent = nullptr)
virtual ~ImageOverlay() override
Esri::ArcGISRuntime::Envelope extent() const
Esri::ArcGISRuntime::ImageFrame *imageFrame() const
bool isVisible() const
float opacity() const
void setOpacity(float opacity)
void setVisible(bool visible)

Detailed Description

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.

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

See also ImageFrame and SceneView.

Member Function Documentation

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

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

ImageOverlay::ImageOverlay(QObject *parent = nullptr)

Constructs an empty ImageOverlay object using an optional parent.

[override virtual] ImageOverlay::~ImageOverlay()


Esri::ArcGISRuntime::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.

Esri::ArcGISRuntime::ImageFrame *ImageOverlay::imageFrame() const

Returns the ImageFrame contained in the ImageOverlay.

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::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?