QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
qgsmaptoolcapture.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmaptoolcapture.h - map tool for capturing points, lines, polygons
3 ---------------------
4 begin : January 2006
5 copyright : (C) 2006 by Martin Dobias
6 email : wonder.sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSMAPTOOLCAPTURE_H
17#define QGSMAPTOOLCAPTURE_H
18
19
21#include "qgspointlocator.h"
22#include "qgscompoundcurve.h"
23#include "qgsgeometry.h"
24#include "qobjectuniqueptr.h"
25
26#include <QPoint>
27#include <QList>
28#include "qgis_gui.h"
29
30class QgsRubberBand;
32class QgsVertexMarker;
33class QgsMapLayer;
35class QgsMapToolCaptureRubberBand;
36class QgsCurvePolygon;
39
40
49{
50 Q_OBJECT
51
52 public:
53
56 {
60 CapturePolygon
61 };
62
65 {
66 NoCapabilities = 1 << 0,
67 SupportsCurves = 1 << 1,
68 ValidateGeometries = 1 << 2,
69 };
70
71 Q_DECLARE_FLAGS( Capabilities, Capability )
72
73
74 QgsMapToolCapture( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget, CaptureMode mode );
75
76 ~QgsMapToolCapture() override;
77
81 virtual QgsMapToolCapture::Capabilities capabilities() const;
82
88 virtual bool supportsTechnique( Qgis::CaptureTechnique technique ) const;
89
94 void setCurrentCaptureTechnique( Qgis::CaptureTechnique technique );
95
101 void setCurrentShapeMapTool( const QgsMapToolShapeMetadata *shapeMapToolMetadata ) SIP_SKIP;
102
103 void activate() override;
104 void deactivate() override;
105
111 CaptureMode mode() const { return mCaptureMode; }
112
114 int addCurve( QgsCurve *c );
115
121 void clearCurve( );
122
128 const QgsCompoundCurve *captureCurve() const { return &mCaptureCurve; }
129
135 QList<QgsPointLocator::Match> snappingMatches() const;
136
137 void cadCanvasMoveEvent( QgsMapMouseEvent *e ) override;
138 void cadCanvasReleaseEvent( QgsMapMouseEvent *e ) override;
139
144 void keyPressEvent( QKeyEvent *e ) override;
145
149 void deleteTempRubberBand();
150
152 void clean() override;
153
160 QgsRubberBand *takeRubberBand() SIP_FACTORY;
161
173 QgsPoint mapPoint( const QgsMapMouseEvent &e ) const;
174
185 QgsPoint mapPoint( const QgsPointXY &point ) const;
186
187 // TODO QGIS 4.0 returns an enum instead of a magic constant
188
189 public slots:
190
195 Q_DECL_DEPRECATED void setCircularDigitizingEnabled( bool enable ) SIP_DEPRECATED;
196
202 Q_DECL_DEPRECATED void setStreamDigitizingEnabled( bool enable ) SIP_DEPRECATED;
203
204 private slots:
205 void addError( const QgsGeometry::Error &error );
206 void currentLayerChanged( QgsMapLayer *layer );
208 void updateExtraSnapLayer();
209
210 protected:
211
212 // TODO QGIS 4.0 returns an enum instead of a magic constant
213
223 int nextPoint( const QgsPoint &mapPoint, QgsPoint &layerPoint );
224
225 // TODO QGIS 4.0 returns an enum instead of a magic constant
226
237 int nextPoint( QPoint p, QgsPoint &layerPoint, QgsPoint &mapPoint );
238
239 // TODO QGIS 4.0 returns an enum instead of a magic constant
240
252 int fetchLayerPoint( const QgsPointLocator::Match &match, QgsPoint &layerPoint );
253
258 int addVertex( const QgsPointXY &point );
259
266 int addVertex( const QgsPointXY &mapPoint, const QgsPointLocator::Match &match );
267
274 void undo( bool isAutoRepeat = false );
275
279 void startCapturing();
280
286 bool isCapturing() const;
287
293 int size();
294
300 Q_DECL_DEPRECATED QVector<QgsPointXY> points() const SIP_DEPRECATED;
301
302 // TODO QGIS 4.0 rename it to points()
303
309 QgsPointSequence pointsZM() const;
310
317 Q_DECL_DEPRECATED void setPoints( const QVector<QgsPointXY> &pointList ) SIP_DEPRECATED;
318
325 void setPoints( const QgsPointSequence &pointList );
326
330 void closePolygon();
331
332 protected slots:
333
337 void stopCapturing();
338
339 private:
340
346 virtual void geometryCaptured( const QgsGeometry &geometry ) {Q_UNUSED( geometry )} SIP_FORCE
347
353 virtual void pointCaptured( const QgsPoint &point ) {Q_UNUSED( point )} SIP_FORCE
354
360 virtual void lineCaptured( const QgsCurve *line ) {Q_UNUSED( line )} SIP_FORCE
361
367 virtual void polygonCaptured( const QgsCurvePolygon *polygon ) {Q_UNUSED( polygon )} SIP_FORCE
368
370 bool tracingEnabled();
372 QgsPointXY tracingStartPoint();
374 bool tracingMouseMove( QgsMapMouseEvent *e );
376 bool tracingAddVertex( const QgsPointXY &point );
377
379 QgsMapToolCaptureRubberBand *createCurveRubberBand() const;
380
382 void resetRubberBand();
383
385 CaptureMode mCaptureMode;
386
388 bool mCapturing = false;
389
391 QgsPoint mCaptureFirstPoint;
392 QgsPoint mCaptureLastPoint;
393
396
399
401 QgsCompoundCurve mCaptureCurve;
402
403 QList<QgsPointLocator::Match> mSnappingMatches;
404 QgsPointLocator::Match mCircularIntermediateMatch;
405 QgsPoint mCircularItermediatePoint;
406
407 void validateGeometry();
408 QgsGeometryValidator *mValidator = nullptr;
409 QList< QgsGeometry::Error > mGeomErrors;
410 QList< QgsVertexMarker * > mGeomErrorMarkers;
411
413 QgsVectorLayer *mExtraSnapLayer = nullptr;
415 QgsFeatureId mExtraSnapFeatureId;
416
417 bool mCaptureModeFromLayer = false;
418
419 std::unique_ptr<QgsSnapIndicator> mSnapIndicator;
420
427 QgsPointXY mTracingStartPoint;
428
430 QgsWkbTypes::Type mLineDigitizingType = QgsWkbTypes::LineString;
431
433
435
436 bool mAllowAddingStreamingPoints = false;
437 int mStreamingToleranceInPixels = 1;
438
439 bool mStartNewCurve = false;
440
441 bool mIgnoreSubsequentAutoRepeatUndo = false;
442
443 friend class TestQgsMapToolCapture;
444
445
446};
447
448Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapToolCapture::Capabilities )
449
450#endif
CaptureTechnique
Capture technique.
Definition: qgis.h:153
@ StraightSegments
Default capture mode - capture occurs with straight line segments.
The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of...
Compound curve geometry type.
Curve polygon geometry type.
Abstract base class for curved geometry type.
Definition: qgscurve.h:36
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:164
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:90
Base class for all map layer types.
Definition: qgsmaplayer.h:73
A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas.
The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates ...
virtual void cadCanvasMoveEvent(QgsMapMouseEvent *e)
Override this method when subclassing this class.
void deactivate() override
Unregisters this maptool from the cad dock widget.
virtual void cadCanvasReleaseEvent(QgsMapMouseEvent *e)
Override this method when subclassing this class.
void activate() override
Registers this maptool with the cad dock widget.
QgsMapToolCapture is a base class capable of capturing point, lines and polygons.
CaptureMode mode() const
The capture mode.
CaptureMode
Different capture modes.
@ CaptureNone
Do not capture / determine mode from layer geometry type.
@ CapturePoint
Capture points.
@ CaptureLine
Capture lines.
const QgsCompoundCurve * captureCurve() const
Gets the capture curve.
Capability
Specific capabilities of the tool.
QgsMapToolShapeAbstract is a base class for shape map tools to be used by QgsMapToolCapture.
QgsMapToolShapeMetadata is a base class for shape map tools metadata to be used in QgsMapToolShapeReg...
virtual void keyPressEvent(QKeyEvent *e)
Key event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:193
virtual void clean()
convenient method to clean members
Definition: qgsmaptool.cpp:120
The class defines interface for querying point location:
A class to represent a 2D point.
Definition: qgspointxy.h:59
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:49
A class for drawing transient features (e.g.
Definition: qgsrubberband.h:52
Class that shows snapping marker on map canvas for the current snapping match.
Represents a vector layer which manages a vector based data sets.
A class for marking vertices of features using e.g.
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:70
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define SIP_DEPRECATED
Definition: qgis_sip.h:106
#define SIP_FORCE
Definition: qgis_sip.h:131
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_FACTORY
Definition: qgis_sip.h:76
QVector< QgsPoint > QgsPointSequence
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsField::ConfigurationFlags) CORE_EXPORT QDataStream &operator<<(QDataStream &out
Writes the field to stream out. QGIS version compatibility is not guaranteed.