SketchVertex Class
A class that represents a vertex or mid-vertex in the SketchEditor. More...
| Header: | #include <SketchVertex> |
| Since: | Esri::ArcGISRuntime 100.12 |
| Inherits: | Esri::ArcGISRuntime::Object |
This class was introduced in Esri::ArcGISRuntime 100.12.
Public Functions
| virtual | ~SketchVertex() override |
| int | insertionIndex() const |
| int | partIndex() const |
| Esri::ArcGISRuntime::Point | point() const |
| int | pointIndex() const |
Static Public Members
| Esri::ArcGISRuntime::SketchVertex * | createMidVertex(int partIndex, int insertionIndex, QObject *parent) |
| Esri::ArcGISRuntime::SketchVertex * | createVertex(int partIndex, int pointIndex, QObject *parent) |
Detailed Description
If the pointIndex is greater or equal to 0, then it's a vertex. If the insertionIndex is greater or equal to 0, then it's a mid-vertex. This object cannot have both pointIndex and insertionIndex greater or equal to 0. When the associated sketch editor is modifying a point geometry, the partIndex and pointIndex will both be 0 for a valid vertex. Mid-vertices are not allowed for a single point geometry. When the associated sketch editor is modifying a multi-point geometry, the partIndex will be 0 for a valid vertex. Mid-vertices are not allowed for a multi-point geometry.
Member Function Documentation
[override virtual] SketchVertex::~SketchVertex()
Destructor.
[static] Esri::ArcGISRuntime::SketchVertex *SketchVertex::createMidVertex(int partIndex, int insertionIndex, QObject *parent)
Creates a SketchVertex with partIndex, insertionIndex and optional parent, which will represent a mid-vertex.
[static] Esri::ArcGISRuntime::SketchVertex *SketchVertex::createVertex(int partIndex, int pointIndex, QObject *parent)
Creates a SketchVertex with partIndex, pointIndex and optional parent
int SketchVertex::insertionIndex() const
Returns the index position of the sketch vertex in the insertion collection for the multipart geometry (e.g. multiple points, polyline, polygon).
A pointIndex value of -1 with an insertionIndex value >= 0, indicates that the vertex has not yet been committed to the multipart geometry (i.e. mid-vertex). A pointIndex value >=0 with an insertionIndex value of -1, indicates that vertex has been committed to the multipart geometry (i.e. actual vertex).
int SketchVertex::partIndex() const
Returns the index of the part in the sketch editor's geometry at which this vertex can be found.
Esri::ArcGISRuntime::Point SketchVertex::point() const
Returns the location of the sketch vertex in map coordinates.
int SketchVertex::pointIndex() const
Returns the index position of the sketch vertex in the point collection for the multipart geometry (e.g. multiple points, polyline, polygon).
A pointIndex value of -1 with an insertionIndex value >= 0, indicates that the vertex has not yet been committed to the multipart geometry (i.e. mid-vertex). A pointIndex value >=0 with an insertionIndex value of -1, indicates that vertex has been committed to the multipart geometry (i.e. actual vertex).