Skip To Content ArcGIS for Developers Sign In Dashboard

KmlImageCoordinate Class

class Esri::ArcGISRuntime::KmlImageCoordinate

A KML image coordinate object. More...

Header: #include <KmlImageCoordinate>
Since: Esri::ArcGISRuntime 100.7
Inherits: Esri::ArcGISRuntime::Object

This class was introduced in Esri::ArcGISRuntime 100.7.

Public Functions

KmlImageCoordinate(double x, double y, Esri::ArcGISRuntime::KmlUnitsType xUnits, Esri::ArcGISRuntime::KmlUnitsType yUnits, QObject *parent = nullptr)
virtual ~KmlImageCoordinate() override
double x() const
Esri::ArcGISRuntime::KmlUnitsType xUnits() const
double y() const
Esri::ArcGISRuntime::KmlUnitsType yUnits() const

Detailed Description

According to the OGC 2.3 specification in section 16.26.2 (http://docs.opengeospatial.org/is/12-007r2/12-007r2.html#1254) "Specifies an image coordinate system. The x and y values may each be specified in three different ways - as pixels (pixels), as fractions of the icon (fraction), or as inset pixels (insetPixels), which is an offset in pixels from the upper right corner of the icon. They may or may not be specified in a consistent manner - for example, x can be specified in pixels and y as a fraction." Use the KmlUnitsType enumeration (via the KmlImageCoordinate::xUnits and KmlImageCoordinate::yUnits properties or the KmlImageCoordinate::KmlImageCoordinate() constructor) to establish the KML image coordinate system. Values of type fraction must be between 0.0 and 1.0. Values below 0.0 will be set to 0.0, and values above 1.0 will be set to 1.0. If a non-integral number is specified with a unit type of device- independent pixels (KmlUnitsType::pixels or KmlUnitsType::insetPixels), it will be rounded down to a whole number (e.g. 2.243 will be rounded to 2.0).

See also KmlUnitsType.

Member Function Documentation

KmlImageCoordinate::KmlImageCoordinate(double x, double y, Esri::ArcGISRuntime::KmlUnitsType xUnits, Esri::ArcGISRuntime::KmlUnitsType yUnits, QObject *parent = nullptr)

Creates a KML image coordinate.

  • x - The x component of a point. Default is 0.5
  • y - The y component of a point. Default is 0.5
  • xUnits - Units in which the x value is specified. Default is KmlUnitsType::fraction.
  • yUnits - Units in which the y value is specified. Default is KmlUnitsType::fraction.
  • parent - An optional parent.

See also KmlUnitsType and KmlUnitsType.

[override virtual] KmlImageCoordinate::~KmlImageCoordinate()

Destructor

double KmlImageCoordinate::x() const

The x component of a point.

Esri::ArcGISRuntime::KmlUnitsType KmlImageCoordinate::xUnits() const

Units in which the x value is specified.

double KmlImageCoordinate::y() const

The y component of a point.

Esri::ArcGISRuntime::KmlUnitsType KmlImageCoordinate::yUnits() const

Units in which the y value is specified.


Feedback on this topic?