KmlGroundOverlay Class

Member Function Documentation

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

Creates a KML ground overlay with the specified geometry and icon.

• geometry - The geometry associated to the ground overlay.
• icon - The icon associated to the ground overlay.
• parent - The optional parent QObject.

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.

Ground overlays currently support KmlAltitudeMode::Absolute and KmlAltitudeMode::ClampToGround.

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

[since Esri::ArcGISRuntime 100.6] Esri::ArcGISRuntime::Geometry KmlGroundOverlay::geometry() const

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

[since Esri::ArcGISRuntime 100.6] 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().

[since Esri::ArcGISRuntime 100.7] void KmlGroundOverlay::setAltitudeMode(Esri::ArcGISRuntime::KmlAltitudeMode altitudeMode)

Sets the altitudeMode to altitudeMode.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also altitudeMode().

[since Esri::ArcGISRuntime 100.6] 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.

[since Esri::ArcGISRuntime 100.6] void KmlGroundOverlay::setDrawOrder(int drawOrder)

Sets the KML ground overlay's drawOrder.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also drawOrder.

[since Esri::ArcGISRuntime 100.6] void KmlGroundOverlay::setGeometry(const Esri::ArcGISRuntime::Geometry &geometry)

Sets the geometry to geometry.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also geometry().

[since Esri::ArcGISRuntime 100.6] 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().

[since Esri::ArcGISRuntime 100.6] void KmlGroundOverlay::setRotation(double rotation)

Sets the KML ground overlay's rotation.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also rotation.