The base class for all selectable elements in a GeometryEditor. More...
| Header: | #include <GeometryEditorElement.h> |
| Since: | Esri::ArcGISRuntime 200.1 |
| Inherits: | Esri::ArcGISRuntime::Object |
| Inherited By: | Esri::ArcGISRuntime::GeometryEditorGeometry, Esri::ArcGISRuntime::GeometryEditorMidVertex, Esri::ArcGISRuntime::GeometryEditorPart, and Esri::ArcGISRuntime::GeometryEditorVertex |
Public Functions
| virtual | ~GeometryEditorElement() override |
| bool | canDelete() const |
| bool | canMove() const |
| bool | canRotate() const |
| bool | canScale() const |
| Esri::ArcGISRuntime::Envelope | extent() const |
| Esri::ArcGISRuntime::GeometryEditorElementType | geometryEditorElementType() const |
Detailed Description
GeometryEditor::selectedElement returns an object that inherits from this base class, representing the specific type of element that is selected.
Member Function Documentation
[override virtual] GeometryEditorElement::~GeometryEditorElement ()
Destructor.
bool GeometryEditorElement::canDelete () const
Returns true if this selected element can be deleted interactively, false otherwise.
The value of InteractionConfiguration::isAllowDeletingSelectedElement of the current GeometryEditor::tool determines this value. The element can be deleted programmatically regardless of this value, for example using GeometryEditor::deleteSelectedElement.
A GeometryEditorMidVertex is not part of the GeometryEditor::geometry state, and therefore can never be deleted from the geometry regardless of the InteractionConfiguration settings.
bool GeometryEditorElement::canMove () const
Returns true if this selected element can be moved interactively, false otherwise.
The value of InteractionConfiguration::isAllowMovingSelectedElement of the current GeometryEditor::tool determines this value. The element can be moved programmatically regardless of this value, for example using GeometryEditor::moveSelectedElement(const Esri::ArcGISRuntime::Point&).
A GeometryEditorMidVertex is not part of the GeometryEditor::geometry state, and therefore can never be moved regardless of the InteractionConfiguration settings.
[since Esri::ArcGISRuntime 200.2] bool GeometryEditorElement::canRotate () const
Returns true if this element can be rotated interactively, false otherwise.
The value of InteractionConfiguration::isAllowRotatingSelectedElement of the current GeometryEditor::tool determines this value. The element can be rotated programmatically regardless of this value, for example using GeometryEditor::rotateSelectedElement(double, const Esri::ArcGISRuntime::Point&).
The following can never be rotated interactively, regardless of the InteractionConfiguration settings:
- GeometryEditorVertex
- GeometryEditorMidVertex
- GeometryEditorGeometry when the geometry type is GeometryType::Point
This function was introduced in Esri::ArcGISRuntime 200.2.
[since Esri::ArcGISRuntime 200.2] bool GeometryEditorElement::canScale () const
Returns true if this element can be scaled interactively, false otherwise.
The value of InteractionConfiguration::isAllowScalingSelectedElement of the current GeometryEditor::tool determines this value. The element can be scaled programmatically regardless of this value, for example using GeometryEditor::scaleSelectedElement(double, double, const Esri::ArcGISRuntime::Point&).
The following can never be scaled interactively, regardless of the InteractionConfiguration settings:
- GeometryEditorVertex
- GeometryEditorMidVertex
- GeometryEditorGeometry when the geometry type is GeometryType::Point
This function was introduced in Esri::ArcGISRuntime 200.2.
Esri::ArcGISRuntime::Envelope GeometryEditorElement::extent() const
Returns the extent of the selected element in the SpatialReference of the associated MapView.
To find the specific shape of the selected element instead of its extent, use GeometryEditorGeometry::geometry, GeometryEditorMidVertex::point, GeometryEditorPart::part, or GeometryEditorVertex::point.
Esri::ArcGISRuntime::GeometryEditorElementType GeometryEditorElement::geometryEditorElementType () const
Returns the type of GeometryEditor element.