Skip To Content ArcGIS for Developers Sign In Dashboard

KmlGroundOverlay Class

(Esri::ArcGISRuntime::KmlGroundOverlay)

An image overlay draped over the terrain. More...

Header: #include <KmlGroundOverlay>
Since: Esri::ArcGISRuntime 100.4
Inherits: KmlNode

Public Functions

KmlGroundOverlay(const Geometry &geometry, KmlIcon *icon, QObject *parent = nullptr)
~KmlGroundOverlay()
double altitude() const
KmlAltitudeMode altitudeMode() const
QColor color() const
int drawOrder() const
Geometry geometry() const
KmlIcon *icon() const
double rotation() const
void setAltitude(double altitude)
void setColor(const QColor &color)
void setDrawOrder(int drawOrder)
void setGeometry(const Geometry &geometry)
void setIcon(KmlIcon *icon)
void setRotation(double rotation)

Additional Inherited Members

Detailed Description

An image overlay draped over the terrain.

Member Function Documentation

KmlGroundOverlay::KmlGroundOverlay(const Geometry &geometry, KmlIcon *icon, QObject *parent = nullptr)

Construct a KmlGroundOverlay from a geometry and an icon, with an optional parent.

This function was introduced in Esri::ArcGISRuntime 100.6.

KmlGroundOverlay::~KmlGroundOverlay()

Destructor.

double KmlGroundOverlay::altitude() const

Returns the KML ground overlay's altitude in meters.

See also setAltitude().

KmlAltitudeMode KmlGroundOverlay::altitudeMode() const

Returns the altitude mode of the KML ground overlay.

QColor KmlGroundOverlay::color() const

Returns the color mask to be applied to the KML ground overlay's image.

The color mask can be used to blend the image associated with KML ground overlay. Pixels in the overlay image are multiplied by this color channel-by-channel. Colors in KML are specified in ABGR order. As of version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.

See also setColor().

int KmlGroundOverlay::drawOrder() const

Returns the KML ground overlay's draw order.

Draw order defines the stacking order for the images in overlapping overlays. Overlays with higher draw order values are drawn on top of overlays with lower draw order values.

See also setDrawOrder().

Geometry KmlGroundOverlay::geometry() const

Returns the geometry for the KML ground overlay.

See also setGeometry().

KmlIcon *KmlGroundOverlay::icon() const

Returns the KML ground overlay icon.

See also setIcon().

double KmlGroundOverlay::rotation() const

Returns the KML ground overlay's rotation.

The rotation of the overlay about its center, in degrees. Values can be +/-180. The default is 0 (north). Rotations are specified in a counterclockwise direction.

See also setRotation().

void KmlGroundOverlay::setAltitude(double altitude)

Sets the KML ground overlay's altitude in meters.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also altitude().

void KmlGroundOverlay::setColor(const QColor &color)

Sets the color mask to be applied to the KML ground overlay's image.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also color.

void KmlGroundOverlay::setDrawOrder(int drawOrder)

Sets the KML ground overlay's drawOrder.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also drawOrder.

void KmlGroundOverlay::setGeometry(const Geometry &geometry)

Sets the geometry for the KML ground overlay.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also geometry().

void KmlGroundOverlay::setIcon(KmlIcon *icon)

Sets the KML ground overlay icon.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also icon().

void KmlGroundOverlay::setRotation(double rotation)

Sets the KML ground overlay's rotation.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also rotation.


Feedback on this topic?