A mid-vertex element in a GeometryEditor. More...
Header: | #include <GeometryEditorMidVertex.h> |
Since: | Esri::ArcGISRuntime 200.1 |
Inherits: | Esri::ArcGISRuntime::GeometryEditorElement |
Public Functions
virtual | ~GeometryEditorMidVertex() override |
int | partIndex() const |
Esri::ArcGISRuntime::Point | point() const |
int | segmentIndex() const |
Detailed Description
Mid-vertices do not exist in the GeometryEditor::geometry, but instead exist only in the display. They are displayed between vertices in polygon and polyline geometries and are used in interactive workflows as a visual cue to indicate new vertices can be inserted between existing vertices. They may be most helpful for users with less editing experience. Tap on a mid-vertex to select it, and drag to change the mid-vertex into a vertex (GeometryEditorVertex) in the GeometryEditor::geometry and move it to the required location.
When a mid-vertex is selected (displayed with a selection halo), a GeometryEditorMidVertex is returned from GeometryEditor::selectedElement. Select a mid-vertex programmatically using GeometryEditor::selectMidVertex(int, int).
Use GeometryEditorStyle::midVertexSymbol and GeometryEditorStyle::selectedMidVertexSymbol to change the appearance of the mid-vertex when unselected and selected, or set to nullptr
to prevent mid-vertices from being displayed entirely. If mid-vertices are not displayed, you can still insert vertices between existing vertices by selecting an existing GeometryEditorVertex and tapping on the map at the location to insert the new vertex.
To prevent mid-vertices from being selected interactively while still allowing programmatic selection, set InteractionConfiguration::setAllowMidVertexSelection to false
. If InteractionConfiguration::isAllowVertexCreation is false
then new vertices cannot be inserted into the geometry, including by the use of mid-vertices.
See also GeometryEditorVertex, GeometryEditor, and InteractionConfiguration.
Member Function Documentation
[override virtual]
GeometryEditorMidVertex::~GeometryEditorMidVertex ()
Destructor.
int GeometryEditorMidVertex::partIndex () const
Returns the index position of the part within the part collection of a multipart geometry that contains this GeometryEditorMidVertex.
Esri::ArcGISRuntime::Point GeometryEditorMidVertex::point() const
Returns the location of the point represented by this GeometryEditorMidVertex in the SpatialReference of the associated MapView.
int GeometryEditorMidVertex::segmentIndex () const
Returns the index position of the segment on which the selected mid-vertex lies.