QGIS API Documentation  2.99.0-Master (13a3f2f)
Public Member Functions | Protected Member Functions | List of all members
QgsMapToolCapture Class Reference

#include <qgsmaptoolcapture.h>

Inheritance diagram for QgsMapToolCapture:
Inheritance graph
[legend]

Public Member Functions

 QgsMapToolCapture (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget, CaptureMode mode=CaptureNone)
 constructor More...
 
virtual ~QgsMapToolCapture ()
 
virtual 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...
 
virtual void cadCanvasMoveEvent (QgsMapMouseEvent *e) override
 Override this method when subclassing this class. More...
 
const QgsCompoundCurvecaptureCurve () const
 Get the capture curve. More...
 
virtual void deactivate () override
 Unregisters this maptool from the cad dock widget. More...
 
void deleteTempRubberBand ()
 Clean a temporary rubberband. More...
 
virtual void keyPressEvent (QKeyEvent *e) override
 Intercept key events like Esc or Del to delete the last point. More...
 
- Public Member Functions inherited from QgsMapToolAdvancedDigitizing
 QgsMapToolAdvancedDigitizing (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
 Creates an advanced digitizing maptool. More...
 
QgsAdvancedDigitizingDockWidgetcadDockWidget () const
 
virtual void canvasMoveEvent (QgsMapMouseEvent *e) override
 Catch the mouse move event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
virtual void canvasPressEvent (QgsMapMouseEvent *e) override
 Catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
virtual void canvasReleaseEvent (QgsMapMouseEvent *e) override
 Catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
CaptureMode mode () const
 The capture mode. More...
 
void setMode (CaptureMode mode)
 Set capture mode. More...
 
- Public Member Functions inherited from QgsMapToolEdit
 QgsMapToolEdit (QgsMapCanvas *canvas)
 
double defaultZValue () const
 Return default Z value Use for set Z coordinate to new vertex for 2.5d geometries. More...
 
virtual Flags flags () const override
 Returns the flags for the map tool. More...
 
- Public Member Functions inherited from QgsMapTool
virtual ~QgsMapTool ()
 
QAction * action ()
 Return associated action with map tool or NULL if no action is associated. More...
 
QAbstractButton * button ()
 Return 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)
 Set 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 Member Functions

int addVertex (const QgsPoint &point)
 Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates) More...
 
int addVertex (const QgsPoint &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, QgsPointV2 &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 QgsPointV2 &mapPoint, QgsPointV2 &layerPoint)
 Converts a map point to layer coordinates. More...
 
int nextPoint (QPoint p, QgsPointV2 &layerPoint, QgsPointV2 &mapPoint)
 Converts a point to map coordinates and layer coordinates. More...
 
QList< QgsPointpoints ()
 List of digitized points. More...
 
void setPoints (const QList< QgsPoint > &pointList)
 Set the points on which to work. More...
 
int size ()
 Number of points digitized. More...
 
void startCapturing ()
 Start capturing. More...
 
void stopCapturing ()
 Stop capturing. More...
 
void undo ()
 Removes the last vertex from mRubberBand and mCaptureList. More...
 
- Protected Member Functions inherited from QgsMapToolAdvancedDigitizing
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...
 
- Protected Member Functions inherited from QgsMapToolEdit
int addTopologicalPoints (const QList< QgsPoint > &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 QgsPoint &point)
 transformation from map coordinates to screen coordinates More...
 
QgsPoint toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
 transformation from screen coordinates to layer's coordinates More...
 
QgsPoint toLayerCoordinates (const QgsMapLayer *layer, const QgsPoint &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...
 
QgsPoint toMapCoordinates (QPoint point)
 transformation from screen coordinates to map coordinates 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...
 
QgsPointV2 toMapCoordinates (const QgsMapLayer *layer, const QgsPointV2 &point)
 transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...
 

Additional Inherited Members

- Public Types inherited from QgsMapToolAdvancedDigitizing
enum  CaptureMode {
  CaptureNone, CapturePoint, CaptureSegment, 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...
 
- 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, QgsMessageBar::MessageLevel=QgsMessageBar::INFO)
 emit a message More...
 
- Static Public Member Functions inherited from QgsMapTool
static double searchRadiusMM ()
 Get search radius in mm. More...
 
static double searchRadiusMU (const QgsRenderContext &context)
 Get search radius in map units for given context. More...
 
static double searchRadiusMU (QgsMapCanvas *canvas)
 Get 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 QgsMapToolAdvancedDigitizing
CaptureMode mCaptureMode
 The capture mode in which this tool operates. More...
 
bool mSnapOnDoubleClick
 Snap on double click. More...
 
bool mSnapOnMove
 Snap on move. More...
 
bool mSnapOnPress
 Snap on press. More...
 
bool mSnapOnRelease
 Snap on release. 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 36 of file qgsmaptoolcapture.h.

Constructor & Destructor Documentation

◆ QgsMapToolCapture()

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

constructor

Definition at line 41 of file qgsmaptoolcapture.cpp.

◆ ~QgsMapToolCapture()

QgsMapToolCapture::~QgsMapToolCapture ( )
virtual

Definition at line 69 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 82 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 455 of file qgsmaptoolcapture.cpp.

◆ addVertex() [1/2]

int QgsMapToolCapture::addVertex ( const QgsPoint 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 386 of file qgsmaptoolcapture.cpp.

◆ addVertex() [2/2]

int QgsMapToolCapture::addVertex ( const QgsPoint 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 391 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 261 of file qgsmaptoolcapture.cpp.

◆ captureCurve()

const QgsCompoundCurve* QgsMapToolCapture::captureCurve ( ) const
inline

Get the capture curve.

Returns
Capture curve

Definition at line 57 of file qgsmaptoolcapture.h.

◆ closePolygon()

void QgsMapToolCapture::closePolygon ( )
protected

Close an open polygon.

Definition at line 615 of file qgsmaptoolcapture.cpp.

◆ deactivate()

void QgsMapToolCapture::deactivate ( )
overridevirtual

Unregisters this maptool from the cad dock widget.

Reimplemented from QgsMapToolAdvancedDigitizing.

Definition at line 90 of file qgsmaptoolcapture.cpp.

◆ deleteTempRubberBand()

void QgsMapToolCapture::deleteTempRubberBand ( )

Clean a temporary rubberband.

Definition at line 606 of file qgsmaptoolcapture.cpp.

◆ fetchLayerPoint()

int QgsMapToolCapture::fetchLayerPoint ( const QgsPointLocator::Match match,
QgsPointV2 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 356 of file qgsmaptoolcapture.cpp.

◆ isCapturing()

bool QgsMapToolCapture::isCapturing ( ) const
protected

Are we currently capturing?

Returns
Is the tool in capture mode?

Definition at line 562 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 539 of file qgsmaptoolcapture.cpp.

◆ nextPoint() [1/2]

int QgsMapToolCapture::nextPoint ( const QgsPointV2 mapPoint,
QgsPointV2 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 323 of file qgsmaptoolcapture.cpp.

◆ nextPoint() [2/2]

int QgsMapToolCapture::nextPoint ( QPoint  p,
QgsPointV2 layerPoint,
QgsPointV2 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 350 of file qgsmaptoolcapture.cpp.

◆ points()

QList< QgsPoint > QgsMapToolCapture::points ( )
protected

List of digitized points.

Returns
List of points

Definition at line 703 of file qgsmaptoolcapture.cpp.

◆ setPoints()

void QgsMapToolCapture::setPoints ( const QList< QgsPoint > &  pointList)
protected

Set the points on which to work.

Parameters
pointListA list of points

Definition at line 712 of file qgsmaptoolcapture.cpp.

◆ size()

int QgsMapToolCapture::size ( )
protected

Number of points digitized.

Returns
Number of points

Definition at line 698 of file qgsmaptoolcapture.cpp.

◆ startCapturing()

void QgsMapToolCapture::startCapturing ( )
protected

Start capturing.

Definition at line 557 of file qgsmaptoolcapture.cpp.

◆ stopCapturing()

void QgsMapToolCapture::stopCapturing ( )
protected

Stop capturing.

Definition at line 567 of file qgsmaptoolcapture.cpp.

◆ undo()

void QgsMapToolCapture::undo ( )
protected

Removes the last vertex from mRubberBand and mCaptureList.

Definition at line 501 of file qgsmaptoolcapture.cpp.


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