QgsMapToolCapture is a base class capable of capturing point, lines and polygons. More...

#include <qgsmaptoolcapture.h>

Inheritance diagram for QgsMapToolCapture:

[legend]

Public Types
typedef QFlags< Capability >	Capabilities

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...

typedef QFlags< Flag >	Flags

Public Slots
Q_DECL_DEPRECATED void	setCircularDigitizingEnabled (bool enable)
	Enable the digitizing with curve.

Q_DECL_DEPRECATED void	setStreamDigitizingEnabled (bool enable)
	Toggles the stream digitizing mode.

Public Member Functions
	QgsMapToolCapture (QgsMapCanvas canvas, QgsAdvancedDigitizingDockWidget cadDockWidget, CaptureMode mode)
	constructor

	~QgsMapToolCapture () override

void	activate () override
	Registers this maptool with the cad dock widget.

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

void	cadCanvasMoveEvent (QgsMapMouseEvent *e) override
	Override this method when subclassing this class.

void	cadCanvasReleaseEvent (QgsMapMouseEvent *e) override
	Override this method when subclassing this class.

virtual QgsMapToolCapture::Capabilities	capabilities () const
	Returns flags containing the supported capabilities.

const QgsCompoundCurve *	captureCurve () const
	Gets the capture curve.

void	clean () override
	convenient method to clean members

void	clearCurve ()
	Clear capture curve.

Qgis::CaptureTechnique	currentCaptureTechnique () const
	Returns the active capture technique.

void	deactivate () override
	Unregisters this maptool from the cad dock widget.

void	deleteTempRubberBand ()
	Clean a temporary rubberband.

void	keyPressEvent (QKeyEvent *e) override
	Intercept key events like Esc or Del to delete the last point.

QgsPoint	mapPoint (const QgsMapMouseEvent &e) const
	Creates a QgsPoint with ZM support if necessary (according to the WkbType of the current layer).

QgsPoint	mapPoint (const QgsPointXY &point) const
	Creates a QgsPoint with ZM support if necessary (according to the WkbType of the current layer).

CaptureMode	mode () const
	The capture mode.

void	setCurrentCaptureTechnique (Qgis::CaptureTechnique technique)
	Sets the current capture if it is supported by the map tool.

void	setCurrentShapeMapTool (const QgsMapToolShapeMetadata *shapeMapToolMetadata)
	Sets the current shape tool.

QList< QgsPointLocator::Match >	snappingMatches () const
	Returns a list of matches for each point on the captureCurve.

virtual bool	supportsTechnique (Qgis::CaptureTechnique technique) const
	Returns `true` if the tool supports the specified capture technique.

QgsRubberBand *	takeRubberBand ()
	Returns the rubberBand currently owned by this map tool and transfers ownership to the caller.

Public Member Functions inherited from QgsMapToolAdvancedDigitizing
	QgsMapToolAdvancedDigitizing (QgsMapCanvas canvas, QgsAdvancedDigitizingDockWidget cadDockWidget)
	Creates an advanced digitizing maptool.

	~QgsMapToolAdvancedDigitizing () override

virtual void	cadCanvasPressEvent (QgsMapMouseEvent *e)
	Override this method when subclassing this class.

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.

void	canvasPressEvent (QgsMapMouseEvent *e) override
	Catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method.

void	canvasReleaseEvent (QgsMapMouseEvent *e) override
	Catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method.

bool	isAdvancedDigitizingAllowed () const
	Returns whether functionality of advanced digitizing dock widget is currently allowed.

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.

virtual QgsMapLayer *	layer () const
	Returns the layer associated with the map tool.

void	setSnapToLayerGridEnabled (bool snapToLayerGridEnabled)
	Enables or disables snap to grid of mouse events.

bool	snapToLayerGridEnabled () const
	Enables or disables snap to grid of mouse events.

bool	useSnappingIndicator () const
	Returns whether the snapping indicator should automatically be used.

Public Member Functions inherited from QgsMapToolEdit
	QgsMapToolEdit (QgsMapCanvas *canvas)

QgsGeometryRubberBand *	createGeometryRubberBand (Qgis::GeometryType geometryType=Qgis::GeometryType::Line, bool alternativeBand=false) const
	Creates a geometry rubber band with the color/line width from the QGIS settings.

Flags	flags () const override
	Returns the flags for the map tool.

Public Member Functions inherited from QgsMapTool
	~QgsMapTool () override

QAction *	action ()
	Returns associated action with map tool or `nullptr` if no action is associated.

QAbstractButton *	button ()
	Returns associated button with map tool or `nullptr` if no button is associated.

QgsMapCanvas *	canvas () const
	returns pointer to the tool's map canvas

virtual void	canvasDoubleClickEvent (QgsMapMouseEvent *e)
	Mouse double-click event for overriding. Default implementation does nothing.

virtual bool	canvasToolTipEvent (QHelpEvent *e)
	Tooltip event for overriding.

virtual bool	gestureEvent (QGestureEvent *e)
	gesture event for overriding. Default implementation does nothing.

bool	isActive () const
	Returns if the current map tool active on the map canvas.

virtual void	keyReleaseEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing.

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.

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.

virtual void	reactivate ()
	Called when the map tool is being activated while it is already active.

void	setAction (QAction *action)
	Use this to associate a QAction to this maptool.

void	setButton (QAbstractButton *button)
	Use this to associate a button to this maptool.

virtual void	setCursor (const QCursor &cursor)
	Sets a user defined cursor.

QgsPointXY	toMapCoordinates (QPoint point)
	Transforms a point from screen coordinates to map coordinates.

QString	toolName ()
	Emit map tool changed with the old tool.

virtual void	wheelEvent (QWheelEvent *e)
	Mouse wheel event for overriding. Default implementation does nothing.

Protected Slots
void	stopCapturing ()
	Stop capturing.

Protected Member Functions
int	addVertex (const QgsPointXY &mapPoint, const QgsPointLocator::Match &match)
	Variant to supply more information in the case of snapping.

int	addVertex (const QgsPointXY &point)
	Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates)

void	closePolygon ()
	Close an open polygon.

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.

bool	isCapturing () const
	Are we currently capturing?

int	nextPoint (const QgsPoint &mapPoint, QgsPoint &layerPoint)
	Converts a map point to layer coordinates.

int	nextPoint (QPoint p, QgsPoint &layerPoint, QgsPoint &mapPoint)
	Converts a point to map coordinates and layer coordinates.

Q_DECL_DEPRECATED QVector< QgsPointXY >	points () const
	List of digitized points.

QgsPointSequence	pointsZM () const
	List of digitized points.

void	setPoints (const QgsPointSequence &pointList)
	Set the points on which to work.

Q_DECL_DEPRECATED void	setPoints (const QVector< QgsPointXY > &pointList)
	Set the points on which to work.

int	size ()
	Number of points digitized.

void	startCapturing ()
	Start capturing.

void	undo (bool isAutoRepeat=false)
	Removes the last vertex from mRubberBand and mCaptureList.

Protected Member Functions inherited from QgsMapToolAdvancedDigitizing
void	setAdvancedDigitizingAllowed (bool allowed)
	Sets whether functionality of advanced digitizing dock widget is currently allowed.

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.

void	setUseSnappingIndicator (bool enabled)
	Sets whether a snapping indicator should automatically be used.

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.

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.

QgsRubberBand *	createRubberBand (Qgis::GeometryType geometryType=Qgis::GeometryType::Line, bool alternativeBand=false)
	Creates a rubber band with the color/line width from the QGIS settings.

QgsVectorLayer *	currentVectorLayer ()
	Returns the current vector layer of the map canvas or 0.

void	notifyNotEditableLayer ()
	Display a timed message bar noting the active vector layer is not editable.

void	notifyNotVectorLayer ()
	Display a timed message bar noting the active layer is not vector.

Protected Member Functions inherited from QgsMapTool
	QgsMapTool (QgsMapCanvas *canvas)
	Constructor takes a map canvas as a parameter.

QgsMapLayer *	layer (const QString &id)
	Returns the map layer with the matching ID, or `nullptr` if no layers could be found.

void	setToolName (const QString &name)
	Sets the tool's name.

QPoint	toCanvasCoordinates (const QgsPointXY &point) const
	Transforms a point from map coordinates to screen coordinates.

QgsPoint	toLayerCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
	Transforms a point from map coordinates to layer coordinates.

QgsPointXY	toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
	Transforms a point from map coordinates to layer coordinates.

QgsRectangle	toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect)
	Transforms a rect from map coordinates to layer coordinates.

QgsPointXY	toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
	Transforms a point from screen coordinates to layer coordinates.

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).

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).

Friends
class	TestQgsMapToolCapture

Additional Inherited Members
Signals inherited from QgsMapTool
void	activated ()
	signal emitted once the map tool is activated

void	deactivated ()
	signal emitted once the map tool is deactivated

void	messageDiscarded ()
	emit signal to clear previous message

void	messageEmitted (const QString &message, Qgis::MessageLevel=Qgis::MessageLevel::Info)
	emit a message

void	reactivated ()

Static Public Member Functions inherited from QgsMapToolEdit
static double	defaultMValue ()
	Returns default M value.

static double	defaultZValue ()
	Returns default Z value.

Static Public Member Functions inherited from QgsMapTool
static double	searchRadiusMM ()
	Gets search radius in mm.

static double	searchRadiusMU (const QgsRenderContext &context)
	Gets search radius in map units for given context.

static double	searchRadiusMU (QgsMapCanvas *canvas)
	Gets search radius in map units for given canvas.

Protected Types inherited from QgsMapToolEdit
enum	TopologicalResult { Success = 0 , InvalidCanvas = 1 , InvalidLayer = 2 }
	Result of addTopologicalPoints. More...

Static Protected Member Functions inherited from QgsMapToolEdit
static QColor	digitizingFillColor ()
	Returns fill color for rubber bands (from global settings)

static QColor	digitizingStrokeColor ()
	Returns stroke color for rubber bands (from global settings)

static int	digitizingStrokeWidth ()
	Returns stroke width for rubber bands (from global settings)

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.

QAbstractButton *	mButton = nullptr
	Optional pointer to a button that will be checked on map tool activation and unchecked on map tool deactivation.

QPointer< QgsMapCanvas >	mCanvas
	The pointer to the map canvas.

QCursor	mCursor
	The cursor used in the map tool.

QString	mToolName
	The translated name of the map tool.

Detailed Description

QgsMapToolCapture is a base class capable of capturing point, lines and polygons.

The tool supports different techniques: straight segments, curves, streaming and shapes Once the the geometry is captured the virtual private handler geometryCaptured is called as well as a more specific handler (pointCaptured, lineCaptured or polygonCaptured)

Definition at line 48 of file qgsmaptoolcapture.h.

Member Typedef Documentation

◆ Capabilities

typedef QFlags< Capability > QgsMapToolCapture::Capabilities

Definition at line 70 of file qgsmaptoolcapture.h.

Member Enumeration Documentation

◆ Capability

enum QgsMapToolCapture::Capability

Specific capabilities of the tool.

Enumerator

NoCapabilities

No specific capabilities.

SupportsCurves

Supports curved geometries input.

ValidateGeometries

Tool supports geometry validation.

Since: QGIS 3.22

Definition at line 63 of file qgsmaptoolcapture.h.

◆ CaptureMode

enum QgsMapToolCapture::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 54 of file qgsmaptoolcapture.h.

Constructor & Destructor Documentation

◆ QgsMapToolCapture()

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

constructor

Definition at line 48 of file qgsmaptoolcapture.cpp.

◆ ~QgsMapToolCapture()

QgsMapToolCapture::~QgsMapToolCapture ( )

override

Definition at line 75 of file qgsmaptoolcapture.cpp.

Member Function Documentation

◆ activate()

void QgsMapToolCapture::activate ( )

overridevirtual

Registers this maptool with the cad dock widget.

Reimplemented from QgsMapToolAdvancedDigitizing.

Reimplemented in QgsMapToolDigitizeFeature.

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

◆ addVertex() [1/2]

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

protected

Variant to supply more information in the case of snapping.

Parameters

mapPoint	The vertex to add in map coordinates
match	Data about the snapping match. Can be an invalid match, if point not snapped.

Definition at line 691 of file qgsmaptoolcapture.cpp.

◆ addVertex() [2/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, 2 if coordinate transformation failed

Definition at line 686 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

e	Mouse events prepared by the cad system

Reimplemented from QgsMapToolAdvancedDigitizing.

Definition at line 493 of file qgsmaptoolcapture.cpp.

◆ cadCanvasReleaseEvent()

void QgsMapToolCapture::cadCanvasReleaseEvent ( QgsMapMouseEvent * e )

overridevirtual

Override this method when subclassing this class.

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

Parameters

e	Mouse events prepared by the cad system

Reimplemented from QgsMapToolAdvancedDigitizing.

Reimplemented in QgsMapToolDigitizeFeature.

Definition at line 1266 of file qgsmaptoolcapture.cpp.

◆ capabilities()

QgsMapToolCapture::Capabilities QgsMapToolCapture::capabilities ( ) const

virtual

Returns flags containing the supported capabilities.

Reimplemented in QgsMapToolCaptureAnnotationItem, and QgsMapToolDigitizeFeature.

Definition at line 97 of file qgsmaptoolcapture.cpp.

◆ captureCurve()

const QgsCompoundCurve * QgsMapToolCapture::captureCurve ( ) const

inline

Gets the capture curve.

Returns: Capture curve

Definition at line 132 of file qgsmaptoolcapture.h.

◆ clean()

void QgsMapToolCapture::clean ( )

overridevirtual

convenient method to clean members

Reimplemented from QgsMapTool.

Definition at line 1039 of file qgsmaptoolcapture.cpp.

◆ clearCurve()

void QgsMapToolCapture::clearCurve ( )

Clear capture curve.

Definition at line 865 of file qgsmaptoolcapture.cpp.

◆ closePolygon()

void QgsMapToolCapture::closePolygon ( )

protected

Close an open polygon.

Definition at line 1048 of file qgsmaptoolcapture.cpp.

◆ currentCaptureTechnique()

Qgis::CaptureTechnique QgsMapToolCapture::currentCaptureTechnique ( ) const

inline

Returns the active capture technique.

Since: QGIS 3.32

Definition at line 99 of file qgsmaptoolcapture.h.

◆ deactivate()

void QgsMapToolCapture::deactivate ( )

overridevirtual

Unregisters this maptool from the cad dock widget.

Reimplemented from QgsMapToolAdvancedDigitizing.

Reimplemented in QgsMapToolDigitizeFeature.

Definition at line 128 of file qgsmaptoolcapture.cpp.

◆ deleteTempRubberBand()

void QgsMapToolCapture::deleteTempRubberBand ( )

Clean a temporary rubberband.

Definition at line 1034 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.

If topological editing is activated, the points are projected to the current layer CRS.

Returns: 0 in case of success 1 if not applicable (CRS mismatch / invalid layer) 2 in case of failure

Definition at line 623 of file qgsmaptoolcapture.cpp.

◆ isCapturing()

bool QgsMapToolCapture::isCapturing ( ) const

protected

Are we currently capturing?

Returns: Is the tool in capture mode?

Definition at line 1006 of file qgsmaptoolcapture.cpp.

◆ keyPressEvent()

void QgsMapToolCapture::keyPressEvent ( QKeyEvent * e )

overridevirtual

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

Parameters

e key event

Reimplemented from QgsMapTool.

Reimplemented in QgsMapToolDigitizeFeature.

Definition at line 956 of file qgsmaptoolcapture.cpp.

◆ mapPoint() [1/2]

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

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 derived from the snapped point.

Parameters

e	A mouse event

Returns: a point with ZM support if necessary

Definition at line 1210 of file qgsmaptoolcapture.cpp.

◆ mapPoint() [2/2]

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

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

Parameters

point A point in 2D

Returns: a point with ZM support if necessary

Definition at line 1171 of file qgsmaptoolcapture.cpp.

◆ mode()

CaptureMode QgsMapToolCapture::mode ( ) const

inline

The capture mode.

Returns: Capture mode

Definition at line 116 of file qgsmaptoolcapture.h.

◆ nextPoint() [1/2]

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

protected

Converts a map point to layer coordinates.

Parameters

	mapPoint	the point in map coordinates
[in,out]	layerPoint	the point in layer coordinates

Returns: 0 in case of success 1 if the current layer is nullptr 2 if the transformation failed

Definition at line 590 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

	p	the input point
[in,out]	layerPoint	the point in layer coordinates
[in,out]	mapPoint	the point in map coordinates

Returns: 0 in case of success 1 if the current layer is nullptr or not a vector layer 2 if the transformation failed

Definition at line 617 of file qgsmaptoolcapture.cpp.

◆ points()

QVector< QgsPointXY > QgsMapToolCapture::points ( ) const

protected

List of digitized points.

Returns: List of points

Deprecated:: QGIS 3.12. Will be removed in QGIS 4.0. Use the variant returns QgsPoint objects instead of QgsPointXY.

Definition at line 1132 of file qgsmaptoolcapture.cpp.

◆ pointsZM()

QgsPointSequence QgsMapToolCapture::pointsZM ( ) const

protected

List of digitized points.

Returns: List of points

Since: QGIS 3.12

Definition at line 1140 of file qgsmaptoolcapture.cpp.

◆ setCircularDigitizingEnabled

void QgsMapToolCapture::setCircularDigitizingEnabled ( bool enable )

slot

Enable the digitizing with curve.

Deprecated:: QGIS 3.26. Use setCurrentCaptureTechnique() instead.

Definition at line 414 of file qgsmaptoolcapture.cpp.

◆ setCurrentCaptureTechnique()

void QgsMapToolCapture::setCurrentCaptureTechnique ( Qgis::CaptureTechnique technique )

Sets the current capture if it is supported by the map tool.

Since: QGIS 3.26

Definition at line 430 of file qgsmaptoolcapture.cpp.

◆ setCurrentShapeMapTool()

void QgsMapToolCapture::setCurrentShapeMapTool ( const QgsMapToolShapeMetadata * shapeMapToolMetadata )

Sets the current shape tool.

See also: QgsMapToolShapeRegistry

Since: QGIS 3.26

Definition at line 472 of file qgsmaptoolcapture.cpp.

◆ setPoints() [1/2]

void QgsMapToolCapture::setPoints ( const QgsPointSequence & pointList )

protected

Set the points on which to work.

Parameters

pointList A list of points

Since: QGIS 3.12

Definition at line 1159 of file qgsmaptoolcapture.cpp.

◆ setPoints() [2/2]

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

protected

Set the points on which to work.

Parameters

pointList A list of points

Deprecated:: QGIS 3.12. Will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.

Definition at line 1147 of file qgsmaptoolcapture.cpp.

◆ setStreamDigitizingEnabled

void QgsMapToolCapture::setStreamDigitizingEnabled ( bool enable )

slot

Toggles the stream digitizing mode.

Since: QGIS 3.20

Deprecated:: QGIS 3.26. Use setCurrentCaptureTechnique() instead.

Definition at line 422 of file qgsmaptoolcapture.cpp.

◆ size()

int QgsMapToolCapture::size ( )

protected

Number of points digitized.

Returns: Number of points

Definition at line 1127 of file qgsmaptoolcapture.cpp.

◆ snappingMatches()

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

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

Definition at line 871 of file qgsmaptoolcapture.cpp.

◆ startCapturing()

void QgsMapToolCapture::startCapturing ( )

protected

Start capturing.

Definition at line 1001 of file qgsmaptoolcapture.cpp.

◆ stopCapturing

void QgsMapToolCapture::stopCapturing ( )

protectedslot

Stop capturing.

Definition at line 1011 of file qgsmaptoolcapture.cpp.

◆ supportsTechnique()

bool QgsMapToolCapture::supportsTechnique ( Qgis::CaptureTechnique technique ) const

virtual

Returns true if the tool supports the specified capture technique.

Since: QGIS 3.20

Reimplemented in QgsMapToolCaptureAnnotationItem, and QgsMapToolDigitizeFeature.

Definition at line 102 of file qgsmaptoolcapture.cpp.

◆ takeRubberBand()

QgsRubberBand * QgsMapToolCapture::takeRubberBand ( )

Returns the rubberBand currently owned by this map tool and transfers ownership to the caller.

May be nullptr.

Since: QGIS 3.8

Definition at line 409 of file qgsmaptoolcapture.cpp.

◆ undo()

void QgsMapToolCapture::undo ( bool isAutoRepeat = false )

protected

Removes the last vertex from mRubberBand and mCaptureList.

Since QGIS 3.20, if isAutoRepeat is set to true then the undo operation will be treated as a auto repeated undo as if the user has held down the undo key for an extended period of time.

Definition at line 876 of file qgsmaptoolcapture.cpp.

Friends And Related Symbol Documentation

◆ TestQgsMapToolCapture

friend class TestQgsMapToolCapture

friend

Definition at line 442 of file qgsmaptoolcapture.h.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/maptools/qgsmaptoolcapture.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/maptools/qgsmaptoolcapture.cpp

Public Types

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Capabilities

Member Enumeration Documentation

◆ Capability

◆ CaptureMode

Constructor & Destructor Documentation

◆ QgsMapToolCapture()

◆ ~QgsMapToolCapture()

Member Function Documentation

◆ activate()

◆ addCurve()

◆ addVertex() [1/2]

◆ addVertex() [2/2]

◆ cadCanvasMoveEvent()

◆ cadCanvasReleaseEvent()

◆ capabilities()

◆ captureCurve()

◆ clean()

◆ clearCurve()

◆ closePolygon()

◆ currentCaptureTechnique()

◆ deactivate()

◆ deleteTempRubberBand()

◆ fetchLayerPoint()

◆ isCapturing()

◆ keyPressEvent()

◆ mapPoint() [1/2]

◆ mapPoint() [2/2]

◆ mode()

◆ nextPoint() [1/2]

◆ nextPoint() [2/2]

◆ points()

◆ pointsZM()

◆ setCircularDigitizingEnabled

◆ setCurrentCaptureTechnique()

◆ setCurrentShapeMapTool()

◆ setPoints() [1/2]

◆ setPoints() [2/2]

◆ setStreamDigitizingEnabled

◆ size()

◆ snappingMatches()

◆ startCapturing()

◆ stopCapturing

◆ supportsTechnique()

◆ takeRubberBand()

◆ undo()

Friends And Related Symbol Documentation

◆ TestQgsMapToolCapture