QgsMapToolCaptureLayerGeometry is a base class for map tools digitizing layer geometries This map tool subclass automatically handles intersection avoidance with other layers in the active project whenever a geometry is digitized by the user. More...
#include <qgsmaptoolcapturelayergeometry.h>
Inheritance diagram for QgsMapToolCaptureLayerGeometry:
Public Member Functions | |
| QgsMapToolCaptureLayerGeometry (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget, CaptureMode mode) | |
| Constructor. More... | |
 Public Member Functions inherited from QgsMapToolCapture | |
| QgsMapToolCapture (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget, CaptureMode mode) | |
| constructor More... | |
| ~QgsMapToolCapture () override | |
| void | activate () override |
| Registers this maptool with the cad dock widget. More... | |
| int | addCurve (QgsCurve *c) |
| Adds a whole curve (e.g. circularstring) to the captured geometry. Curve must be in map CRS. More... | |
| void | cadCanvasMoveEvent (QgsMapMouseEvent *e) override |
| Override this method when subclassing this class. More... | |
| void | cadCanvasReleaseEvent (QgsMapMouseEvent *e) override |
| Override this method when subclassing this class. More... | |
| virtual QgsMapToolCapture::Capabilities | capabilities () const |
| Returns flags containing the supported capabilities. More... | |
| const QgsCompoundCurve * | captureCurve () const |
| Gets the capture curve. More... | |
| void | clean () override |
| convenient method to clean members More... | |
| void | clearCurve () |
| Clear capture curve. More... | |
| void | deactivate () override |
| Unregisters this maptool from the cad dock widget. More... | |
| void | deleteTempRubberBand () |
| Clean a temporary rubberband. More... | |
| void | keyPressEvent (QKeyEvent *e) override |
| Intercept key events like Esc or Del to delete the last point. More... | |
| QgsPoint | mapPoint (const QgsMapMouseEvent &e) const |
| Creates a QgsPoint with ZM support if necessary (according to the WkbType of the current layer). More... | |
| QgsPoint | mapPoint (const QgsPointXY &point) const |
| Creates a QgsPoint with ZM support if necessary (according to the WkbType of the current layer). More... | |
| CaptureMode | mode () const |
| The capture mode. More... | |
| void | setCurrentCaptureTechnique (Qgis::CaptureTechnique technique) |
| Sets the current capture if it is supported by the map tool. More... | |
| void | setCurrentShapeMapTool (const QgsMapToolShapeMetadata *shapeMapToolMetadata) |
| Sets the current shape tool. More... | |
| QList< QgsPointLocator::Match > | snappingMatches () const |
| Returns a list of matches for each point on the captureCurve. More... | |
| virtual bool | supportsTechnique (Qgis::CaptureTechnique technique) const |
Returns true if the tool supports the specified capture technique. More... | |
| QgsRubberBand * | takeRubberBand () |
| Returns the rubberBand currently owned by this map tool and transfers ownership to the caller. More... | |
| Public Member Functions inherited from QgsMapToolAdvancedDigitizing | |
| QgsMapToolAdvancedDigitizing (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget) | |
| Creates an advanced digitizing maptool. More... | |
| void | activate () override |
| Registers this maptool with the cad dock widget. More... | |
| virtual void | cadCanvasMoveEvent (QgsMapMouseEvent *e) |
| Override this method when subclassing this class. More... | |
| virtual void | cadCanvasPressEvent (QgsMapMouseEvent *e) |
| Override this method when subclassing this class. More... | |
| virtual void | cadCanvasReleaseEvent (QgsMapMouseEvent *e) |
| Override this method when subclassing this class. More... | |
| QgsAdvancedDigitizingDockWidget * | cadDockWidget () const |
| void | canvasMoveEvent (QgsMapMouseEvent *e) override |
| Catch the mouse move event, filters it, transforms it to map coordinates and send it to virtual method. More... | |
| void | canvasPressEvent (QgsMapMouseEvent *e) override |
| Catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method. More... | |
| void | canvasReleaseEvent (QgsMapMouseEvent *e) override |
| Catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method. More... | |
| void | deactivate () override |
| Unregisters this maptool from the cad dock widget. More... | |
| bool | isAdvancedDigitizingAllowed () const |
| Returns whether functionality of advanced digitizing dock widget is currently allowed. More... | |
| bool | isAutoSnapEnabled () const |
| Returns whether mouse events (press/move/release) should automatically try to snap mouse position (according to the snapping configuration of map canvas) before passing the mouse coordinates to the tool. More... | |
| virtual QgsMapLayer * | layer () const |
| Returns the layer associated with the map tool. More... | |
| void | setSnapToLayerGridEnabled (bool snapToLayerGridEnabled) |
| Enables or disables snap to grid of mouse events. More... | |
| bool | snapToLayerGridEnabled () const |
| Enables or disables snap to grid of mouse events. More... | |
| Public Member Functions inherited from QgsMapToolEdit | |
| QgsMapToolEdit (QgsMapCanvas *canvas) | |
| QgsGeometryRubberBand * | createGeometryRubberBand (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry, bool alternativeBand=false) const |
| Creates a geometry rubber band with the color/line width from the QGIS settings. More... | |
| Flags | flags () const override |
| Returns the flags for the map tool. More... | |
| Public Member Functions inherited from QgsMapTool | |
| ~QgsMapTool () override | |
| QAction * | action () |
Returns associated action with map tool or nullptr if no action is associated. More... | |
| virtual void | activate () |
| called when set as currently active map tool More... | |
| QAbstractButton * | button () |
Returns associated button with map tool or nullptr if no button is associated. More... | |
| QgsMapCanvas * | canvas () const |
| returns pointer to the tool's map canvas More... | |
| virtual void | canvasDoubleClickEvent (QgsMapMouseEvent *e) |
| Mouse double-click event for overriding. Default implementation does nothing. More... | |
| virtual void | canvasMoveEvent (QgsMapMouseEvent *e) |
| Mouse move event for overriding. Default implementation does nothing. More... | |
| virtual void | canvasPressEvent (QgsMapMouseEvent *e) |
| Mouse press event for overriding. Default implementation does nothing. More... | |
| virtual void | canvasReleaseEvent (QgsMapMouseEvent *e) |
| Mouse release event for overriding. Default implementation does nothing. More... | |
| virtual bool | canvasToolTipEvent (QHelpEvent *e) |
| Tooltip event for overriding. More... | |
| virtual void | clean () |
| convenient method to clean members More... | |
| virtual void | deactivate () |
| called when map tool is being deactivated More... | |
| virtual Flags | flags () const |
| Returns the flags for the map tool. More... | |
| virtual bool | gestureEvent (QGestureEvent *e) |
| gesture event for overriding. Default implementation does nothing. More... | |
| bool | isActive () const |
| Returns if the current map tool active on the map canvas. More... | |
| virtual void | keyPressEvent (QKeyEvent *e) |
| Key event for overriding. Default implementation does nothing. More... | |
| virtual void | keyReleaseEvent (QKeyEvent *e) |
| Key event for overriding. Default implementation does nothing. More... | |
| virtual void | populateContextMenu (QMenu *menu) |
| Allows the tool to populate and customize the given menu, prior to showing it in response to a right-mouse button click. More... | |
| virtual bool | populateContextMenuWithEvent (QMenu *menu, QgsMapMouseEvent *event) |
| Allows the tool to populate and customize the given menu, prior to showing it in response to a right-mouse button click. More... | |
| void | setAction (QAction *action) |
| Use this to associate a QAction to this maptool. More... | |
| void | setButton (QAbstractButton *button) |
| Use this to associate a button to this maptool. More... | |
| virtual void | setCursor (const QCursor &cursor) |
| Sets a user defined cursor. More... | |
| QgsPointXY | toMapCoordinates (QPoint point) |
| Transforms a point from screen coordinates to map coordinates. More... | |
| QString | toolName () |
| Emit map tool changed with the old tool. More... | |
| virtual void | wheelEvent (QWheelEvent *e) |
| Mouse wheel event for overriding. Default implementation does nothing. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsMapToolCapture | |
| enum | Capability { NoCapabilities = 1 << 0 , SupportsCurves = 1 << 1 , ValidateGeometries = 1 << 2 } |
| Specific capabilities of the tool. More... | |
| enum | CaptureMode { CaptureNone , CapturePoint , CaptureLine , CapturePolygon } |
| Different capture modes. More... | |
| Public Types inherited from QgsMapTool | |
| enum | Flag { Transient = 1 << 1 , EditTool = 1 << 2 , AllowZoomRect = 1 << 3 , ShowContextMenu = 1 << 4 } |
| Enumeration of flags that adjust the way the map tool operates. More... | |
| Public Slots inherited from QgsMapToolCapture | |
| Q_DECL_DEPRECATED void | setCircularDigitizingEnabled (bool enable) |
| Enable the digitizing with curve. More... | |
| Q_DECL_DEPRECATED void | setStreamDigitizingEnabled (bool enable) |
| Toggles the stream digitizing mode. More... | |
| Signals inherited from QgsMapTool | |
| void | activated () |
| signal emitted once the map tool is activated More... | |
| void | deactivated () |
| signal emitted once the map tool is deactivated More... | |
| void | messageDiscarded () |
| emit signal to clear previous message More... | |
| void | messageEmitted (const QString &message, Qgis::MessageLevel=Qgis::MessageLevel::Info) |
| emit a message More... | |
| Static Public Member Functions inherited from QgsMapToolEdit | |
| static double | defaultMValue () |
| Returns default M value. More... | |
| static double | defaultZValue () |
| Returns default Z value. More... | |
| Static Public Member Functions inherited from QgsMapTool | |
| static double | searchRadiusMM () |
| Gets search radius in mm. More... | |
| static double | searchRadiusMU (const QgsRenderContext &context) |
| Gets search radius in map units for given context. More... | |
| static double | searchRadiusMU (QgsMapCanvas *canvas) |
| Gets search radius in map units for given canvas. More... | |
| Protected Types inherited from QgsMapToolEdit | |
| enum | TopologicalResult { Success = 0 , InvalidCanvas = 1 , InvalidLayer = 2 } |
| Result of addTopologicalPoints. More... | |
| Protected Slots inherited from QgsMapToolCapture | |
| void | stopCapturing () |
| Stop capturing. More... | |
| Protected Member Functions inherited from QgsMapToolCapture | |
| int | addVertex (const QgsPointXY &mapPoint, const QgsPointLocator::Match &match) |
| Variant to supply more information in the case of snapping. More... | |
| int | addVertex (const QgsPointXY &point) |
| Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates) More... | |
| void | closePolygon () |
| Close an open polygon. More... | |
| int | fetchLayerPoint (const QgsPointLocator::Match &match, QgsPoint &layerPoint) |
| Fetches the original point from the source layer if it has the same CRS as the current layer. More... | |
| bool | isCapturing () const |
| Are we currently capturing? More... | |
| int | nextPoint (const QgsPoint &mapPoint, QgsPoint &layerPoint) |
| Converts a map point to layer coordinates. More... | |
| int | nextPoint (QPoint p, QgsPoint &layerPoint, QgsPoint &mapPoint) |
| Converts a point to map coordinates and layer coordinates. More... | |
| Q_DECL_DEPRECATED QVector< QgsPointXY > | points () const |
| List of digitized points. More... | |
| QgsPointSequence | pointsZM () const |
| List of digitized points. More... | |
| void | setPoints (const QgsPointSequence &pointList) |
| Set the points on which to work. More... | |
| Q_DECL_DEPRECATED void | setPoints (const QVector< QgsPointXY > &pointList) |
| Set the points on which to work. More... | |
| int | size () |
| Number of points digitized. More... | |
| void | startCapturing () |
| Start capturing. More... | |
| void | undo (bool isAutoRepeat=false) |
| Removes the last vertex from mRubberBand and mCaptureList. More... | |
| Protected Member Functions inherited from QgsMapToolAdvancedDigitizing | |
| void | setAdvancedDigitizingAllowed (bool allowed) |
| Sets whether functionality of advanced digitizing dock widget is currently allowed. More... | |
| void | setAutoSnapEnabled (bool enabled) |
| Sets whether mouse events (press/move/release) should automatically try to snap mouse position This method is protected because it should be a decision of the map tool and not from elsewhere. More... | |
| Protected Member Functions inherited from QgsMapToolEdit | |
| TopologicalResult | addTopologicalPoints (const QVector< QgsPoint > &vertices) |
| Adds a list of vertices to other features to keep topology up to date, e.g. More... | |
| Q_DECL_DEPRECATED TopologicalResult | addTopologicalPoints (const QVector< QgsPointXY > &vertices) |
| Adds a list of vertices to other features to keep topology up to date, e.g. More... | |
| QgsRubberBand * | createRubberBand (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry, bool alternativeBand=false) |
| Creates a rubber band with the color/line width from the QGIS settings. More... | |
| QgsVectorLayer * | currentVectorLayer () |
| Returns the current vector layer of the map canvas or 0. More... | |
| void | notifyNotEditableLayer () |
| Display a timed message bar noting the active vector layer is not editable. More... | |
| void | notifyNotVectorLayer () |
| Display a timed message bar noting the active layer is not vector. More... | |
| Protected Member Functions inherited from QgsMapTool | |
| QgsMapTool (QgsMapCanvas *canvas) | |
| Constructor takes a map canvas as a parameter. More... | |
| QgsMapLayer * | layer (const QString &id) |
Returns the map layer with the matching ID, or nullptr if no layers could be found. More... | |
| void | setToolName (const QString &name) |
| Sets the tool's name. More... | |
| QPoint | toCanvasCoordinates (const QgsPointXY &point) const |
| Transforms a point from map coordinates to screen coordinates. More... | |
| QgsPoint | toLayerCoordinates (const QgsMapLayer *layer, const QgsPoint &point) |
| Transforms a point from map coordinates to layer coordinates. More... | |
| QgsPointXY | toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point) |
| Transforms a point from map coordinates to layer coordinates. More... | |
| QgsRectangle | toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect) |
| Transforms a rect from map coordinates to layer coordinates. More... | |
| QgsPointXY | toLayerCoordinates (const QgsMapLayer *layer, QPoint point) |
| Transforms a point from screen coordinates to layer coordinates. More... | |
| QgsPoint | toMapCoordinates (const QgsMapLayer *layer, const QgsPoint &point) |
| Transforms a point from layer coordinates to map coordinates (which is different in case reprojection is used). More... | |
| QgsPointXY | toMapCoordinates (const QgsMapLayer *layer, const QgsPointXY &point) |
| Transforms a point from layer coordinates to map coordinates (which is different in case reprojection is used). More... | |
| Static Protected Member Functions inherited from QgsMapToolEdit | |
| static QColor | digitizingFillColor () |
| Returns fill color for rubber bands (from global settings) More... | |
| static QColor | digitizingStrokeColor () |
| Returns stroke color for rubber bands (from global settings) More... | |
| static int | digitizingStrokeWidth () |
| Returns stroke width for rubber bands (from global settings) More... | |
| Protected Attributes inherited from QgsMapToolAdvancedDigitizing | |
| QgsAdvancedDigitizingDockWidget * | mCadDockWidget = nullptr |
| Protected Attributes inherited from QgsMapTool | |
| QAction * | mAction = nullptr |
| Optional pointer to an action that will be checked on map tool activation and unchecked on map tool deactivation. More... | |
| QAbstractButton * | mButton = nullptr |
| Optional pointer to a button that will be checked on map tool activation and unchecked on map tool deactivation. More... | |
| QPointer< QgsMapCanvas > | mCanvas |
| The pointer to the map canvas. More... | |
| QCursor | mCursor |
| The cursor used in the map tool. More... | |
| QString | mToolName |
| The translated name of the map tool. More... | |
Detailed Description
QgsMapToolCaptureLayerGeometry is a base class for map tools digitizing layer geometries This map tool subclass automatically handles intersection avoidance with other layers in the active project whenever a geometry is digitized by the user.
- Since
- QGIS 3.26
Definition at line 30 of file qgsmaptoolcapturelayergeometry.h.
Constructor & Destructor Documentation
◆ QgsMapToolCaptureLayerGeometry()
|
inline |
Constructor.
Definition at line 35 of file qgsmaptoolcapturelayergeometry.h.
The documentation for this class was generated from the following files:
- /build/qgis-3.28.0+99sid/src/gui/maptools/qgsmaptoolcapturelayergeometry.h
- /build/qgis-3.28.0+99sid/src/gui/maptools/qgsmaptoolcapturelayergeometry.cpp
