Polygon Class

  • Polygon
  • class Esri::ArcGISRuntime::Polygon

    A multipart shape used to represent an area. More...

    Header: #include <Polygon.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Multipart

    Public Functions

    Polygon(const Esri::ArcGISRuntime::Polygon &other)
    Polygon(Esri::ArcGISRuntime::Polygon &&other)
    Polygon(const Esri::ArcGISRuntime::Geometry &other)
    virtual ~Polygon() override
    bool isValid() const
    Esri::ArcGISRuntime::Polyline toPolyline() const
    Esri::ArcGISRuntime::Polygon &operator=(const Esri::ArcGISRuntime::Polygon &other)
    Esri::ArcGISRuntime::Polygon &operator=(Esri::ArcGISRuntime::Polygon &&other)

    Detailed Description

    A Polygon geometry represents the shape and location of an area, for example, a country, island, or a lake. A polygon can be used as the geometry of features and graphics, or as input or output of tasks or geoprocessing operations, such as the output of a drive-time analysis or a GeometryEngine::buffer(const Esri::ArcGISRuntime::Geometry&, double) operation.

    Each part of a multipart polygon is a series of connected Segments forming a closed ring. Each part must not cross any other part but may lie completely inside or outside another part. For example, a polygon representing the state of Hawaii would comprise eight disjoint parts, one representing each island. A polygon representing the country of South Africa, which completely surrounds the enclave of Lesotho, would comprise two parts, one contained inside the other.

    Polygon is similar to Polyline in that they are both composed of a series of connected segments. Like Polyline, the Polygon class is a Multipart, which provides members for iterating the segments and points of each part in a Polyline. Unlike parts in a Polyline, however, each part of a polygon defines a closed area, so the end point of the last segment in the part is always in the same location as the start point of the first segment, forming a closed boundary.

    When defining a polygon part, there is no need to explicitly close it by repeating the start point as the last point. Polygon parts are always interpreted as enclosed areas by this API. However, you may need to simplify a polygon created with this API before storing it in a geodatabase or using it in geometry operations that rely on topological consistency. Interior rings to make donut polygons should be counter-clockwise in direction to have the correct topology.

    If there is ever a doubt about the topological correctness of a polygon, call the GeometryEngine::simplify(const Esri::ArcGISRuntime::Geometry&) method to correct any issues. This is especially true if you pass a polygon to ArcGIS Server for a geoprocessing task to avoid any ArcGIS Server errors being thrown or to rectify polygons that may be self-intersecting, have rings which are partially contained in each other, or contain incorrect ring orientations.

    Polygons are based upon the parent Geometry class. The geometry object is immutable which means that you can not change its shape once it is created. If you need to create a new polygon or modify it once it has been created, use the PolygonBuilder class.

    A polygon can be used as the geometry of a Feature or Graphic. To obtain the geometry on these objects, use lGeoElement.geometry.

    See also Geometry.

    Member Function Documentation


    Default constructor.

    Polygon::Polygon(const Esri::ArcGISRuntime::Polygon &other)

    Copy constructor from other Polygon.

    Polygon::Polygon(Esri::ArcGISRuntime::Polygon &&other)

    Move constructor from other Polygon.

    [explicit] Polygon::Polygon(const Esri::ArcGISRuntime::Geometry &other)

    Converting constructor from other Geometry.

    See also Downcast helper functions.

    [override virtual] Polygon::~Polygon()


    [since Esri::ArcGISRuntime 100.2] bool Polygon::isValid() const

    Gets whether this Polygon is valid.

    A Polygon is valid if it is not empty and geometryType is GeometryType::Polygon.

    Returns true if valid.

    This function was introduced in Esri::ArcGISRuntime 100.2.

    [since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::Polyline Polygon::toPolyline() const

    Returns a polyline containing paths for all the rings in this polygon.

    This function was introduced in Esri::ArcGISRuntime 100.3.

    Esri::ArcGISRuntime::Polygon &Polygon::operator=(const Esri::ArcGISRuntime::Polygon &other)

    Assignment operator from other Polygon.

    Esri::ArcGISRuntime::Polygon &Polygon::operator=(Esri::ArcGISRuntime::Polygon &&other)

    Move operator from other Polygon.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.