Skip To Content ArcGIS for Developers Sign In Dashboard

ImageFrame Class

class Esri::ArcGISRuntime::ImageFrame

A frame that, when added to an ImageOverlay, renders an image on top of a scene. More...

Header: #include <ImageFrame>
Since: Esri::ArcGISRuntime 100.8
Inherits: Esri::ArcGISRuntime::Object, Esri::ArcGISRuntime::Loadable, and Esri::ArcGISRuntime::RemoteResource

This class was introduced in Esri::ArcGISRuntime 100.8.

Public Functions

ImageFrame(const QImage &image, const Esri::ArcGISRuntime::Polygon &quadrilateral, QObject *parent = nullptr)
ImageFrame(const QImage &image, const Esri::ArcGISRuntime::Envelope &extent, QObject *parent = nullptr)
ImageFrame(const QUrl &url, const Esri::ArcGISRuntime::Polygon &quadrilateral, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
ImageFrame(const QUrl &url, const Esri::ArcGISRuntime::Polygon &quadrilateral, QObject *parent = nullptr)
ImageFrame(const QUrl &url, const Esri::ArcGISRuntime::Envelope &extent, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
ImageFrame(const QUrl &url, const Esri::ArcGISRuntime::Envelope &extent, QObject *parent = nullptr)
ImageFrame(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
ImageFrame(const QUrl &url, QObject *parent = nullptr)
virtual ~ImageFrame() override
Esri::ArcGISRuntime::Envelope extent() const
QImage image() const
Esri::ArcGISRuntime::Polygon quadrilateral() const

Reimplemented Public Functions

virtual void cancelLoad() override
virtual Esri::ArcGISRuntime::Credential *credential() const override
virtual void load() override
virtual Esri::ArcGISRuntime::Error loadError() const override
virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
virtual Esri::ArcGISRuntime::RequestConfiguration requestConfiguration() const override
virtual void retryLoad() override
virtual void setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration) override
virtual QUrl url() const override

Signals

void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Detailed Description

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

See also ImageOverlay.

Member Function Documentation

ImageFrame::ImageFrame(const QImage &image, const Esri::ArcGISRuntime::Polygon &quadrilateral, QObject *parent = nullptr)

Creates an ImageFrame containing the image, quadrilateral, and an optional parent.

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

ImageFrame::ImageFrame(const QImage &image, const Esri::ArcGISRuntime::Envelope &extent, QObject *parent = nullptr)

Creates an ImageFrame containing the image at the specified geographic extent, and an optional parent.

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.

ImageFrame::ImageFrame(const QUrl &url, const Esri::ArcGISRuntime::Polygon &quadrilateral, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Creates an ImageFrame containing the image identified by the url secured by a credential for display, quadrilateral, and an optional parent.

This url could be a local file path, Qt resource path, or HTTP path to the image.

The quadrilateral in this case is a four-point polygon and the image frame will fail to load if the number of points is more or less. If a spatial reference is not defined for the polygon, it is assumed to be the same as the scene. Otherwise, the extent will be projected to match the scene.

A credential is specified if the image needs authentication to gain access to it.

Supported image formats are GEOTIFF, TIFF, JPEG, and PNG.

ImageFrame::ImageFrame(const QUrl &url, const Esri::ArcGISRuntime::Polygon &quadrilateral, QObject *parent = nullptr)

Constructor that creates an ImageFrame containing the image identified by the url for display, quadrilateral, and an optional parent.

This url could be a local file path, Qt resource path, or HTTP path to the image.

If a spatial reference is not defined for the quadrilateral, 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 quadrilateral doesn't contain exactly four points, the image frame will fail to load.

Supported image formats are GEOTIFF, TIFF, JPEG, and PNG.

ImageFrame::ImageFrame(const QUrl &url, const Esri::ArcGISRuntime::Envelope &extent, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Creates an ImageFrame containing the image identified by the url secured by a credential, for display at the specified geographic extent and an optional parent.

This url could be a local file path, Qt resource path, or HTTP path to the image.

If a spatial reference is not defined for the extent, it is assumed to be the same as the scene. Otherwise, the extent will be projected to match the scene.

A credential is specified if the image needs authentication to gain access to it.

Supported image formats are GEOTIFF, TIFF, JPEG, and PNG.

ImageFrame::ImageFrame(const QUrl &url, const Esri::ArcGISRuntime::Envelope &extent, QObject *parent = nullptr)

Creates an ImageFrame containing the image identified by the url for display at the specified geographic extent and an optional parent.

This url could be a local file path, Qt resource path, or HTTP path to the image.

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.

ImageFrame::ImageFrame(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Creates an image frame containing the image defined by the url, a credential, and an optional parent.

This url could be a local file path, Qt resource path, or HTTP path to the image.

A credential is specified if the image needs authentication to gain access to it.

Supported image formats are GEOTIFF, TIFF, JPEG, and PNG.

ImageFrame::ImageFrame(const QUrl &url, QObject *parent = nullptr)

Creates an image frame containing the image defined by the url and an optional parent.

This url could be a local file path, Qt resource path, or HTTP path to the image.

Supported image formats are GEOTIFF, TIFF, JPEG, and PNG.

[signal] void ImageFrame::doneLoading(Esri::ArcGISRuntime::Error loadError)

Signal emitted when this object is done loading.

  • loadError - Details about any error that may have occurred.

Note: If there is a load error it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

[signal] void ImageFrame::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the load status changes for this object.

See also Loadable.

[override virtual] ImageFrame::~ImageFrame()

Destructor.

[override virtual] void ImageFrame::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Credential *ImageFrame::credential() const

Reimplements: RemoteResource::credential() const.

Returns the credential to be used to access a secured image URL if provided.

Esri::ArcGISRuntime::Envelope ImageFrame::extent() const

Returns the extent of the image.

QImage ImageFrame::image() const

Returns the image contained in the ImageFrame.

[override virtual] void ImageFrame::load()

Reimplements: Loadable::load().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Error ImageFrame::loadError() const

Reimplements: Loadable::loadError() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::LoadStatus ImageFrame::loadStatus() const

Reimplements: Loadable::loadStatus() const.

See Loadable.

Esri::ArcGISRuntime::Polygon ImageFrame::quadrilateral() const

Returns a polygon consisting of four points that represent each corner of the image.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration ImageFrame::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by the ImageFrame.

See also setRequestConfiguration().

[override virtual] void ImageFrame::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.

[override virtual] void ImageFrame::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets configuration parameters used for network requests sent by the ImageFrame to requestConfiguration.

See also requestConfiguration().

[override virtual] QUrl ImageFrame::url() const

Reimplements: RemoteResource::url() const.

Returns the URL path to the image.

This could be a local file path, Qt resource path, or HTTP path to the image.


Feedback on this topic?