Skip To Content ArcGIS for Developers Sign In Dashboard

KmlGroundOverlay Class

class Esri::ArcGISRuntime::KmlGroundOverlay

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

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

This class was introduced in Esri::ArcGISRuntime 100.4.

Public Functions

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

Detailed Description

Member Function Documentation

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

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

The specified geometry must be either an Envelope or a Polygon with exactly 4 points. Other geometry types are not supported.

This function was introduced in Esri::ArcGISRuntime 100.6.

[override virtual] KmlGroundOverlay::~KmlGroundOverlay()

Destructor.

double KmlGroundOverlay::altitude() const

Returns the KML ground overlay's altitude in meters.

See also setAltitude().

Esri::ArcGISRuntime::KmlAltitudeMode KmlGroundOverlay::altitudeMode() const

Returns the altitude mode of the KML ground overlay.

See also setAltitudeMode().

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().

Esri::ArcGISRuntime::Geometry KmlGroundOverlay::geometry() const

Returns the geometry for the KML ground overlay.

See also setGeometry().

Esri::ArcGISRuntime::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::setAltitudeMode(Esri::ArcGISRuntime::KmlAltitudeMode altitudeMode)

Sets the altitude mode of the KML ground overlay to altitudeMode.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also altitudeMode().

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 Esri::ArcGISRuntime::Geometry &geometry)

Sets the geometry for the KML ground overlay.

The specified geometry must be either an Envelope or a Polygon with exactly 4 points. Other geometry types are not supported.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also geometry().

void KmlGroundOverlay::setIcon(Esri::ArcGISRuntime::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?