QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Types | Public Member Functions | Protected Slots | Protected Member Functions | Friends | List of all members
QgsMapToolCapture Class Reference

#include <qgsmaptoolcapture.h>

Inheritance diagram for QgsMapToolCapture:
Inheritance graph
[legend]

Public Types

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 }
 Enumeration of flags that adjust the way the map tool operates. More...
 

Public Member Functions

 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...
 
const QgsCompoundCurvecaptureCurve () 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...
 
CaptureMode mode () const
 The capture mode. More...
 
QList< QgsPointLocator::MatchsnappingMatches () const
 Returns a list of matches for each point on the captureCurve. More...
 
- Public Member Functions inherited from QgsMapToolAdvancedDigitizing
 QgsMapToolAdvancedDigitizing (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
 Creates an advanced digitizing maptool. 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...
 
QgsAdvancedDigitizingDockWidgetcadDockWidget () 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...
 
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...
 
- Public Member Functions inherited from QgsMapToolEdit
 QgsMapToolEdit (QgsMapCanvas *canvas)
 
double defaultZValue () const
 Returns default Z value Use for set Z coordinate to new vertex for 2.5d geometries. 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 NULL if no action is associated. More...
 
QAbstractButton * button ()
 Returns associated button with map tool or NULL if no button is associated. More...
 
QgsMapCanvascanvas ()
 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 bool gestureEvent (QGestureEvent *e)
 gesture event for overriding. Default implementation does nothing. More...
 
virtual void keyReleaseEvent (QKeyEvent *e)
 Key event for overriding. Default implementation does nothing. 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...
 
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...
 

Protected Slots

void stopCapturing ()
 Stop capturing. More...
 

Protected Member Functions

int addVertex (const QgsPointXY &point)
 Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates) More...
 
int addVertex (const QgsPointXY &mapPoint, const QgsPointLocator::Match &match)
 Variant to supply more information in the case of snapping. 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...
 
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...
 
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...
 
QVector< QgsPointXYpoints () const
 List of digitized points. More...
 
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 ()
 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
int addTopologicalPoints (const QVector< QgsPointXY > &geom)
 Adds vertices to other features to keep topology up to date, e.g. More...
 
QgsGeometryRubberBandcreateGeometryRubberBand (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry, bool alternativeBand=false) const
 
QgsRubberBandcreateRubberBand (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry, bool alternativeBand=false)
 Creates a rubber band with the color/line width from the QGIS settings. More...
 
QgsVectorLayercurrentVectorLayer ()
 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 map canvas as a parameter More...
 
QPoint toCanvasCoordinates (const QgsPointXY &point)
 transformation from map coordinates to screen coordinates More...
 
QgsPointXY toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
 transformation from screen coordinates to layer's coordinates More...
 
QgsPointXY toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
 transformation from map coordinates to layer's coordinates More...
 
QgsRectangle toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect)
 trnasformation of the rect from map coordinates to layer's coordinates More...
 
QgsPointXY toMapCoordinates (QPoint point)
 transformation from screen coordinates to map coordinates More...
 
QgsPointXY toMapCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
 transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...
 
QgsPoint toMapCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
 transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...
 

Friends

class TestQgsMapToolReshape
 

Additional Inherited Members

- 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::Info)
 emit a message 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...
 
- 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 QgsMapTool
QAction * mAction = nullptr
 optionally map tool can have pointer to action which will be used to set that action as active More...
 
QAbstractButton * mButton = nullptr
 optionally map tool can have pointer to a button which will be used to set that action as active More...
 
QgsMapCanvasmCanvas = nullptr
 pointer to map canvas More...
 
QCursor mCursor
 cursor used in map tool More...
 
QString mToolName
 translated name of the map tool More...
 

Detailed Description

Definition at line 38 of file qgsmaptoolcapture.h.

Member Enumeration Documentation

◆ CaptureMode

Different capture modes.

Enumerator
CaptureNone 

Do not capture / determine mode from layer geometry type.

CapturePoint 

Capture points.

CaptureLine 

Capture lines.

CapturePolygon 

Capture polygons.

Definition at line 45 of file qgsmaptoolcapture.h.

Constructor & Destructor Documentation

◆ QgsMapToolCapture()

QgsMapToolCapture::QgsMapToolCapture ( QgsMapCanvas canvas,
QgsAdvancedDigitizingDockWidget cadDockWidget,
CaptureMode  mode 
)

constructor

Definition at line 41 of file qgsmaptoolcapture.cpp.

◆ ~QgsMapToolCapture()

QgsMapToolCapture::~QgsMapToolCapture ( )
override

Definition at line 56 of file qgsmaptoolcapture.cpp.

Member Function Documentation

◆ activate()

void QgsMapToolCapture::activate ( )
overridevirtual

Registers this maptool with the cad dock widget.

Reimplemented from QgsMapToolAdvancedDigitizing.

Definition at line 67 of file qgsmaptoolcapture.cpp.

◆ addCurve()

int QgsMapToolCapture::addCurve ( QgsCurve c)

Adds a whole curve (e.g. circularstring) to the captured geometry. Curve must be in map CRS.

Definition at line 503 of file qgsmaptoolcapture.cpp.

◆ addVertex() [1/2]

int QgsMapToolCapture::addVertex ( const QgsPointXY point)
protected

Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates)

Returns
0 in case of success, 1 if current layer is not a vector layer, 2 if coordinate transformation failed

Definition at line 429 of file qgsmaptoolcapture.cpp.

◆ addVertex() [2/2]

int QgsMapToolCapture::addVertex ( const QgsPointXY mapPoint,
const QgsPointLocator::Match match 
)
protected

Variant to supply more information in the case of snapping.

Parameters
mapPointThe vertex to add in map coordinates
matchData about the snapping match. Can be an invalid match, if point not snapped.
Since
QGIS 2.14

Definition at line 434 of file qgsmaptoolcapture.cpp.

◆ cadCanvasMoveEvent()

void QgsMapToolCapture::cadCanvasMoveEvent ( QgsMapMouseEvent e)
overridevirtual

Override this method when subclassing this class.

This will receive adapted events from the cad system whenever a canvasMoveEvent is triggered and it's not hidden by the cad's construction mode.

Parameters
eMouse events prepared by the cad system

Reimplemented from QgsMapToolAdvancedDigitizing.

Definition at line 305 of file qgsmaptoolcapture.cpp.

◆ captureCurve()

const QgsCompoundCurve* QgsMapToolCapture::captureCurve ( ) const
inline

Gets the capture curve.

Returns
Capture curve

Definition at line 83 of file qgsmaptoolcapture.h.

◆ clean()

void QgsMapToolCapture::clean ( )
overridevirtual

convenient method to clean members

Reimplemented from QgsMapTool.

Definition at line 669 of file qgsmaptoolcapture.cpp.

◆ clearCurve()

void QgsMapToolCapture::clearCurve ( )

Clear capture curve.

Since
QGIS 3.0

Definition at line 550 of file qgsmaptoolcapture.cpp.

◆ closePolygon()

void QgsMapToolCapture::closePolygon ( )
protected

Close an open polygon.

Definition at line 675 of file qgsmaptoolcapture.cpp.

◆ deactivate()

void QgsMapToolCapture::deactivate ( )
overridevirtual

Unregisters this maptool from the cad dock widget.

Reimplemented from QgsMapToolAdvancedDigitizing.

Definition at line 75 of file qgsmaptoolcapture.cpp.

◆ deleteTempRubberBand()

void QgsMapToolCapture::deleteTempRubberBand ( )

Clean a temporary rubberband.

Definition at line 660 of file qgsmaptoolcapture.cpp.

◆ fetchLayerPoint()

int QgsMapToolCapture::fetchLayerPoint ( const QgsPointLocator::Match match,
QgsPoint layerPoint 
)
protected

Fetches the original point from the source layer if it has the same CRS as the current layer.

Returns
0 in case of success, 1 if not applicable (CRS mismatch), 2 in case of failure
Since
QGIS 2.14

Definition at line 386 of file qgsmaptoolcapture.cpp.

◆ isCapturing()

bool QgsMapToolCapture::isCapturing ( ) const
protected

Are we currently capturing?

Returns
Is the tool in capture mode?

Definition at line 625 of file qgsmaptoolcapture.cpp.

◆ keyPressEvent()

void QgsMapToolCapture::keyPressEvent ( QKeyEvent *  e)
overridevirtual

Intercept key events like Esc or Del to delete the last point.

Parameters
ekey event

Reimplemented from QgsMapTool.

Definition at line 602 of file qgsmaptoolcapture.cpp.

◆ mapPoint() [1/2]

QgsPoint QgsMapToolCapture::mapPoint ( const QgsMapMouseEvent e) const
protected

Creates a QgsPoint with ZM support if necessary (according to the WkbType of the current layer).

If the point is snapped, then the Z value is took from the snapped point.

Parameters
eA mouse event
Returns
a point with ZM support if necessary
Since
QGIS 3.0

Definition at line 819 of file qgsmaptoolcapture.cpp.

◆ mapPoint() [2/2]

QgsPoint QgsMapToolCapture::mapPoint ( const QgsPointXY point) const
protected

Creates a QgsPoint with ZM support if necessary (according to the WkbType of the current layer).

Parameters
pointA point in 2D
Returns
a point with ZM support if necessary
Since
QGIS 3.0

Definition at line 784 of file qgsmaptoolcapture.cpp.

◆ mode()

CaptureMode QgsMapToolCapture::mode ( ) const
inline

The capture mode.

Returns
Capture mode

Definition at line 66 of file qgsmaptoolcapture.h.

◆ nextPoint() [1/2]

int QgsMapToolCapture::nextPoint ( const QgsPoint mapPoint,
QgsPoint layerPoint 
)
protected

Converts a map point to layer coordinates.

Parameters
mapPointthe point in map coordinates
[in,out]layerPointthe point in layer coordinates
Returns
0 in case of success 1 if the current layer is null or not a vector layer 2 if the transformation failed

Definition at line 353 of file qgsmaptoolcapture.cpp.

◆ nextPoint() [2/2]

int QgsMapToolCapture::nextPoint ( QPoint  p,
QgsPoint layerPoint,
QgsPoint mapPoint 
)
protected

Converts a point to map coordinates and layer coordinates.

Parameters
pthe input point
[in,out]layerPointthe point in layer coordinates
[in,out]mapPointthe point in map coordinates
Returns
0 in case of success 1 if the current layer is null or not a vector layer 2 if the transformation failed

Definition at line 380 of file qgsmaptoolcapture.cpp.

◆ points()

QVector< QgsPointXY > QgsMapToolCapture::points ( ) const
protected

List of digitized points.

Returns
List of points

Definition at line 765 of file qgsmaptoolcapture.cpp.

◆ setPoints()

void QgsMapToolCapture::setPoints ( const QVector< QgsPointXY > &  pointList)
protected

Set the points on which to work.

Parameters
pointListA list of points

Definition at line 774 of file qgsmaptoolcapture.cpp.

◆ size()

int QgsMapToolCapture::size ( )
protected

Number of points digitized.

Returns
Number of points

Definition at line 760 of file qgsmaptoolcapture.cpp.

◆ snappingMatches()

QList< QgsPointLocator::Match > QgsMapToolCapture::snappingMatches ( ) const

Returns a list of matches for each point on the captureCurve.

Since
QGIS 3.0

Definition at line 555 of file qgsmaptoolcapture.cpp.

◆ startCapturing()

void QgsMapToolCapture::startCapturing ( )
protected

Start capturing.

Definition at line 620 of file qgsmaptoolcapture.cpp.

◆ stopCapturing

void QgsMapToolCapture::stopCapturing ( )
protectedslot

Stop capturing.

Definition at line 630 of file qgsmaptoolcapture.cpp.

◆ undo()

void QgsMapToolCapture::undo ( )
protected

Removes the last vertex from mRubberBand and mCaptureList.

Definition at line 561 of file qgsmaptoolcapture.cpp.

Friends And Related Function Documentation

◆ TestQgsMapToolReshape

friend class TestQgsMapToolReshape
friend

Definition at line 283 of file qgsmaptoolcapture.h.


The documentation for this class was generated from the following files: