Contains all the KML-specific information associated with a Geometry. More...
| Header: | #include <KmlGeometry.h> |
| Since: | Esri::ArcGISRuntime 100.4 |
| Inherited By: | Esri::ArcGISRuntime::KmlModel, Esri::ArcGISRuntime::KmlMultiGeometry, Esri::ArcGISRuntime::KmlMultiTrack, and Esri::ArcGISRuntime::KmlTrack |
Public Functions
| KmlGeometry() | |
| KmlGeometry(const Esri::ArcGISRuntime::KmlGeometry &other) | |
| KmlGeometry(Esri::ArcGISRuntime::KmlGeometry &&other) | |
| KmlGeometry(const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::KmlAltitudeMode altitude) | |
| KmlGeometry(const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::KmlAltitudeMode altitude, bool isExtruded) | |
| KmlGeometry(const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::KmlAltitudeMode altitude, bool isExtruded, bool isTessellated) | |
| ~KmlGeometry() | |
| Esri::ArcGISRuntime::KmlAltitudeMode | altitudeMode() const |
| Esri::ArcGISRuntime::Geometry | geometry() const |
| bool | isEmpty() const |
| bool | isExtruded() const |
| bool | isTessellated() const |
| bool | isValid() const |
| Esri::ArcGISRuntime::KmlGeometryObjectType | objectType() const |
| Esri::ArcGISRuntime::KmlGeometryType | type() const |
| bool | operator!=(const Esri::ArcGISRuntime::KmlGeometry &other) const |
| Esri::ArcGISRuntime::KmlGeometry & | operator=(const Esri::ArcGISRuntime::KmlGeometry &other) |
| Esri::ArcGISRuntime::KmlGeometry & | operator=(Esri::ArcGISRuntime::KmlGeometry &&other) |
| bool | operator==(const Esri::ArcGISRuntime::KmlGeometry &other) const |
Detailed Description
Relevant samples:
- Create and save KML file: Construct a KML document and save it as a KMZ file.
Member Function Documentation
KmlGeometry::KmlGeometry ()
Default constructor.
Note: This is provided for convenience only and will construct an unusable, empty object.
KmlGeometry::KmlGeometry (const Esri::ArcGISRuntime::KmlGeometry &other)
Copy constructor from the other KmlGeometry.
KmlGeometry::KmlGeometry (Esri::ArcGISRuntime::KmlGeometry &&other)
Move constructor from the other KmlGeometry.
[since Esri::ArcGISRuntime 100.6] KmlGeometry::KmlGeometry (const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::KmlAltitudeMode altitude)
Creates a {Esri::ArcGISRuntime::KMLGeometry}{KMLGeometry} from a Geometry using a specific altitude mode.
geometry The Geometry used for creating the new KML geometry. altitude The KML altitude mode. Determines how altitude values should be interpreted.
This function was introduced in Esri::ArcGISRuntime 100.6.
[since Esri::ArcGISRuntime 100.6] KmlGeometry::KmlGeometry (const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::KmlAltitudeMode altitude, bool isExtruded )
Creates a KmlGeometry from a Geometry using a specific altitude mode and an extruded flag.
geometry - The Geometry used to create a new KML geometry. altitude - The KML altitude mode. Determines how altitude values should be interpreted. isExtruded - true if the geometry is extruded, false otherwise.
This function was introduced in Esri::ArcGISRuntime 100.6.
[since Esri::ArcGISRuntime 100.6] KmlGeometry::KmlGeometry (const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::KmlAltitudeMode altitude, bool isExtruded , bool isTessellated )
Creates a KMLGeometry from a Geometry using a specific altitude mode, extruded flag, and a tessellated flag.
geometry - The Geometry used to create a new KML geometry. altitude - The KML altitude mode. Determines how altitude values should be interpreted. isExtruded - true if the geometry is extruded, false otherwise. isTessellated - true if the geometry is tessellated, false otherwise.
Polyline, polygon and track geometries can be tessellated. Extrusion is ignored when the altitude mode is set to KmlAltitudeMode::ClampToGround, or when the geometry is a KmlModel.
This function was introduced in Esri::ArcGISRuntime 100.6.
KmlGeometry::~KmlGeometry ()
Destructor.
Esri::ArcGISRuntime::KmlAltitudeMode KmlGeometry::altitudeMode () const
Returns the KML altitude mode.
Esri::ArcGISRuntime::Geometry KmlGeometry::geometry() const
Returns the Geometry contained within the KML geometry.
If there is no contained geometry (e.g. reading a KmlModel with a missing location tag, or an empty KmlMultiGeometry), this property will return an empty point.
bool KmlGeometry::isEmpty () const
Returns whether the object is empty.
Returns true if empty.
bool KmlGeometry::isExtruded () const
Returns a flag indicating if the KML geometry is extruded.
Extrusion is ignored when the altitude mode is set to KmlAltitudeMode::ClampToGround, or when the geometry is a KmlModel.
bool KmlGeometry::isTessellated () const
Returns a flag indicating if the KML geometry is tessellated.
In order for tessellated geometry to follow the terrain, altitudeMode must be KmlAltitudeMode::ClampToGround. Polyline, polygon and track geometries can be tessellated.
[since Esri::ArcGISRuntime 200.6] bool KmlGeometry::isValid () const
Gets whether this KmlGeometry is valid.
A KmlGeometry is valid if it is not empty and objectType is KmlGeometryObjectType::Geometry.
Returns true if valid.
This function was introduced in Esri::ArcGISRuntime 200.6.
[since Esri::ArcGISRuntime 200.6] Esri::ArcGISRuntime::KmlGeometryObjectType KmlGeometry::objectType () const
Returns the type of concrete KML geometry class type this object is.
Note: This is dinstinct from type in that this represents the actual class type instance whereas type represents the KML geometry type. For example a KmlGeometry class instance can represent a Polygon type of geometry and the type will return KmlGeometryType::Polygon, and the objectType will return KmlGeometryObjectType::Geometry.
This function was introduced in Esri::ArcGISRuntime 200.6.
Esri::ArcGISRuntime::KmlGeometryType KmlGeometry::type() const
Returns the KML geometry type.
[since Esri::ArcGISRuntime 200.6] bool KmlGeometry::operator!=(const Esri::ArcGISRuntime::KmlGeometry &other) const
Returns true if this object is not equal to a second KmlGeometry object.
- other - The second object.
This function was introduced in Esri::ArcGISRuntime 200.6.
Esri::ArcGISRuntime::KmlGeometry &KmlGeometry::operator=(const Esri::ArcGISRuntime::KmlGeometry &other)
Assignment operator from other KmlGeometry.
Esri::ArcGISRuntime::KmlGeometry &KmlGeometry::operator=(Esri::ArcGISRuntime::KmlGeometry &&other)
Move operator from other KmlGeometry.
[since Esri::ArcGISRuntime 200.6] bool KmlGeometry::operator==(const Esri::ArcGISRuntime::KmlGeometry &other) const
Returns true if this object is equal to a second KmlGeometry object.
- other - The second object.
This function was introduced in Esri::ArcGISRuntime 200.6.