Skip To Content ArcGIS for Developers Sign In Dashboard

ImageFrame 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: Object, Loadable, and RemoteResource

Public Functions

ImageFrame(const QUrl &url, QObject *parent = nullptr)
ImageFrame(const QUrl &url, Credential *credential, QObject *parent = nullptr)
ImageFrame(const QUrl &url, const Envelope &extent, QObject *parent = nullptr)
ImageFrame(const QUrl &url, const Envelope &extent, Credential *credential, QObject *parent = nullptr)
ImageFrame(const QUrl &url, const Polygon &quadrilateral, QObject *parent = nullptr)
ImageFrame(const QUrl &url, const Polygon &quadrilateral, Credential *credential, QObject *parent = nullptr)
ImageFrame(const QImage &image, const Envelope &extent, QObject *parent = nullptr)
ImageFrame(const QImage &image, const Polygon &quadrilateral, QObject *parent = nullptr)
ImageFrame(std::shared_ptr<QRTImpl::ImageFrameImpl> impl, QObject *parent)
~ImageFrame()
Envelope extent() const
QImage image() const
Polygon quadrilateral() const

Reimplemented Public Functions

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

Signals

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

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

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.

See also ImageOverlay.

Member Function Documentation

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

Constructor that 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.

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

Constructor that 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, const Envelope &extent, QObject *parent = nullptr)

Constructor that 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. Otherwise, the extent will be projected to match the scene.

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

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

Constructor that 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 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.

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.

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

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

Constructor that 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 QImage &image, const Envelope &extent, QObject *parent = nullptr)

Constructor that 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. Otherwise, the extent will be projected to match the scene.

Supported image formats are TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG.

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

Constructor that creates an ImageFrame containing the image, quadrilateral, and an optional parent.

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.

Supported image formats are TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG.

ImageFrame::ImageFrame(std::shared_ptr<QRTImpl::ImageFrameImpl> impl, QObject *parent)

ImageFrame::~ImageFrame()

Destructor.

[virtual] void ImageFrame::cancelLoad()

Reimplemented from Loadable::cancelLoad().

See Loadable.

[virtual] Credential *ImageFrame::credential() const

Reimplemented from RemoteResource::credential().

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

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

Envelope ImageFrame::extent() const

Returns the extent of the image.

QImage ImageFrame::image() const

Returns the image contained in the ImageFrame.

[virtual] void ImageFrame::load()

Reimplemented from Loadable::load().

See Loadable.

[virtual] Error ImageFrame::loadError() const

Reimplemented from Loadable::loadError().

See Loadable.

[virtual] LoadStatus ImageFrame::loadStatus() const

Reimplemented from Loadable::loadStatus().

See Loadable.

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

Signal emitted when the load status changes for this object.

See also Loadable.

Polygon ImageFrame::quadrilateral() const

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

[virtual] RequestConfiguration ImageFrame::requestConfiguration() const

Reimplemented from RemoteResource::requestConfiguration().

Returns the RequestConfiguration in use by the ImageFrame.

See also setRequestConfiguration().

[virtual] void ImageFrame::retryLoad()

Reimplemented from Loadable::retryLoad().

See Loadable.

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

Reimplemented from RemoteResource::setRequestConfiguration().

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

See also requestConfiguration().

[virtual] QUrl ImageFrame::url() const

Reimplemented from RemoteResource::url().

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?