The following members of class SketchEditor are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.
Public Functions
(deprecated) | SketchEditor(QObject *parent = nullptr) |
(deprecated) Esri::ArcGISRuntime::SketchCreationMode | creationMode() const |
(deprecated) Esri::ArcGISRuntime::Geometry | geometry() const |
(deprecated) bool | insertVertexAfterSelectedVertex(const Esri::ArcGISRuntime::Point &point) |
(deprecated) bool | isSketchValid() const |
(deprecated) bool | isStarted() const |
(deprecated) bool | isVisible() const |
(deprecated) bool | moveSelectedVertex(const Esri::ArcGISRuntime::Point &point) |
(deprecated) float | opacity() const |
(deprecated) bool | removeSelectedVertex() |
(deprecated) bool | replaceGeometry(const Esri::ArcGISRuntime::Geometry &geometry) |
(deprecated) Esri::ArcGISRuntime::SketchVertex * | selectedVertex() const |
(deprecated) void | setOpacity(float opacity) |
(deprecated) void | setSelectedVertex(Esri::ArcGISRuntime::SketchVertex *selectedVertex) |
(deprecated) void | setStyle(Esri::ArcGISRuntime::SketchStyle *style) |
(deprecated) void | setVisible(bool visible) |
(deprecated) Esri::ArcGISRuntime::SketchStyle * | style() const |
Public Slots
(deprecated) bool | redo() |
(deprecated) bool | start(const Esri::ArcGISRuntime::Geometry &geometry) |
(deprecated) bool | start(const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::SketchCreationMode creationMode) |
(deprecated) bool | start(const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::SketchCreationMode creationMode, Esri::ArcGISRuntime::SketchEditConfiguration *editConfiguration) |
(deprecated) bool | start(Esri::ArcGISRuntime::SketchCreationMode creationMode) |
(deprecated) bool | start(Esri::ArcGISRuntime::SketchCreationMode creationMode, Esri::ArcGISRuntime::SketchEditConfiguration *editConfiguration) |
(deprecated) void | stop() |
(deprecated) bool | undo() |
Member Function Documentation
SketchEditor::SketchEditor (QObject *parent = nullptr)
This function is deprecated. We strongly advise against using it in new code.
Constructs a SketchEditor with an optional parent.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
Esri::ArcGISRuntime::SketchCreationMode SketchEditor::creationMode () const
This function is deprecated. We strongly advise against using it in new code.
Specifies which type of geometry will be sketched and what type of user interaction is used to create it.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
Esri::ArcGISRuntime::Geometry SketchEditor::geometry() const
This function is deprecated. We strongly advise against using it in new code.
The geometry currently being sketched. It is updated as the user interacts with the view.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
bool SketchEditor::insertVertexAfterSelectedVertex (const Esri::ArcGISRuntime::Point &point)
This function is deprecated. We strongly advise against using it in new code.
Inserts point after the currently selected vertex programmatically. Requires a vertex to be selected. Returns whether the insertion was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
bool SketchEditor::isSketchValid () const
This function is deprecated. We strongly advise against using it in new code.
Returns the result of a lightweight check to see if the current Geometry of this SketchEditor can produce a valid geometry. Returns true if:
- It is a Point and contains non-NaN x and y coordinates
- It is a Multipoint and contains at least one valid vertex
- It is a Polyline with at least 2 valid vertices in each part, and at least one part
- It is a Polygon with at least 3 valid vertices in each part, and at least one part
- It is an Envelope and it contains non-Nan xmin, ymin, xmax, and ymax-coordinates
Prior to Esri::ArcGISRuntime 100.8, only one part of a multipart polygon or polyline was required to have the minimum number (2 for a polyline, 3 for a polygon) of vertices.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
bool SketchEditor::isStarted () const
This function is deprecated. We strongly advise against using it in new code.
Returns whether the sketch editor is started and will respond to user interactions with the view.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
bool SketchEditor::isVisible () const
This function is deprecated. We strongly advise against using it in new code.
Returns whether the SketchEditor is visible.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
bool SketchEditor::moveSelectedVertex (const Esri::ArcGISRuntime::Point &point)
This function is deprecated. We strongly advise against using it in new code.
Moves the selected vertex to point programmatically. Requires a vertex to be selected. Returns whether the move was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
float SketchEditor::opacity() const
This function is deprecated. We strongly advise against using it in new code.
The opacity of the SketchEditor. Ranges between 0.0 and 1.0.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
See also setOpacity().
[slot] bool SketchEditor::redo()
This function is deprecated. We strongly advise against using it in new code.
Redoes the last undo. Returns whether the redo was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
bool SketchEditor::removeSelectedVertex ()
This function is deprecated. We strongly advise against using it in new code.
Removes the currently selected vertex programmatically. Requires a vertex to be selected. Returns whether the removal was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
bool SketchEditor::replaceGeometry (const Esri::ArcGISRuntime::Geometry &geometry)
This function is deprecated. We strongly advise against using it in new code.
Replaces the entire sketch geometry with geometry programmatically. Returns whether the replace was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
Esri::ArcGISRuntime::SketchVertex *SketchEditor::selectedVertex () const
This function is deprecated. We strongly advise against using it in new code.
Returns the currently selected vertex.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
See also setSelectedVertex().
void SketchEditor::setOpacity (float opacity)
This function is deprecated. We strongly advise against using it in new code.
Sets the opacity of the SketchEditor
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
See also opacity.
void SketchEditor::setSelectedVertex (Esri::ArcGISRuntime::SketchVertex *selectedVertex )
This function is deprecated. We strongly advise against using it in new code.
Sets the selectedVertex to selectedVertex.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
See also selectedVertex.
void SketchEditor::setStyle (Esri::ArcGISRuntime::SketchStyle *style)
This function is deprecated. We strongly advise against using it in new code.
Sets the style to style.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
See also style.
void SketchEditor::setVisible (bool visible)
This function is deprecated. We strongly advise against using it in new code.
Sets whether the SketchEditor is visible
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
See also isVisible.
[slot] bool SketchEditor::start(const Esri::ArcGISRuntime::Geometry &geometry)
This function is deprecated. We strongly advise against using it in new code.
Starts a sketch based on the provided geometry.
The sketch editor begins responding to user interactions with the MapView to perform the sketch. The creationMode defaults to SketchCreationMode::Point, SketchCreationMode::Polyline, or SketchCreationMode::Polygon depending upon the type of geometry provided.
Returns whether start was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
[slot] bool SketchEditor::start(const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::SketchCreationMode creationMode )
This function is deprecated. We strongly advise against using it in new code.
Starts a sketch based on the provided geometry and creationMode.
The sketch editor begins responding to user interactions with the MapView to perform the sketch. Returns whether start was successful.
Note: creationMode must correspond to the type of geometry, or start will fail and this method will return false.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
[slot] bool SketchEditor::start(const Esri::ArcGISRuntime::Geometry &geometry, Esri::ArcGISRuntime::SketchCreationMode creationMode , Esri::ArcGISRuntime::SketchEditConfiguration *editConfiguration )
This function is deprecated. We strongly advise against using it in new code.
Starts a sketch based on the provided geometry , creationMode and editConfiguration.
The sketch editor begins responding to user interactions with the MapView to perform the sketch. Depending on how the SketchEditConfiguration is configured, the Sketcheditor will exhibit different behaviours and capabilites. Returns whether start was successful.
Note: creationMode must correspond to the type of geometry, or start will fail and this method will return false.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
[slot] bool SketchEditor::start(Esri::ArcGISRuntime::SketchCreationMode creationMode )
This function is deprecated. We strongly advise against using it in new code.
Starts an empty sketch of type based on the provided creationMode.
The sketch editor begins responding to user interactions with the MapView to perform the sketch. Returns whether start was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
[slot] bool SketchEditor::start(Esri::ArcGISRuntime::SketchCreationMode creationMode , Esri::ArcGISRuntime::SketchEditConfiguration *editConfiguration )
This function is deprecated. We strongly advise against using it in new code.
Starts an empty sketch of geometry type based on the provided creationMode, with capabilities based on provided editConfiguration.
The sketch editor begins responding to user interactions with the MapView to perform the sketch. Depending on how the SketchEditConfiguration is configured, the Sketcheditor will exhibit different behaviours and capabilites. Returns whether start was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
[slot] void SketchEditor::stop()
This function is deprecated. We strongly advise against using it in new code.
Stops the sketch by making the sketch editor no longer respond to user interaction.
This also clears the SketchEditor::geometry.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
Esri::ArcGISRuntime::SketchStyle *SketchEditor::style() const
This function is deprecated. We strongly advise against using it in new code.
Returns the object describing the styling of the sketch editor.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.
See also setStyle().
[slot] bool SketchEditor::undo()
This function is deprecated. We strongly advise against using it in new code.
Undoes the last sketch action. Returns whether the undo was successful.
since Esri::ArcGISRuntime 200.2
Use GeometryEditor instead.