QgsSnappingUtils::LayerConfig Struct Reference

Configures how a certain layer should be handled in a snapping operation. More...

#include <qgssnappingutils.h>

Public Member Functions
	LayerConfig (QgsVectorLayer *l, QgsPointLocator::Types t, double tol, Qgis::MapToolUnit u)
	Create a new configuration for a snapping layer.
bool	operator!= (const QgsSnappingUtils::LayerConfig &other) const
bool	operator== (const QgsSnappingUtils::LayerConfig &other) const

Public Attributes
QgsVectorLayer *	layer = nullptr
	The layer to configure.
double	tolerance
	The range around snapping targets in which snapping should occur.
QgsPointLocator::Types	type
	To which geometry properties of this layers a snapping should happen.
Qgis::MapToolUnit	unit
	The units in which the tolerance is specified.

Detailed Description

Configures how a certain layer should be handled in a snapping operation.

Definition at line 121 of file qgssnappingutils.h.

Constructor & Destructor Documentation

LayerConfig()

QgsSnappingUtils::LayerConfig::LayerConfig ( QgsVectorLayer *  l, QgsPointLocator::Types  t, double  tol, Qgis::MapToolUnit  u  )

inline

Create a new configuration for a snapping layer.

snapper = QgsMapCanvasSnappingUtils(mapCanvas)
 
snapping_layer1 = QgsSnappingUtils.LayerConfig(layer1, QgsPointLocator.Vertex, 10, Qgis::MapToolUnit::Pixels)
snapping_layer2 = QgsSnappingUtils.LayerConfig(layer2, QgsPointLocator.Vertex and QgsPointLocator.Edge, 10, Qgis::MapToolUnit::Pixels)
 
snapper.setLayers([snapping_layer1, snapping_layer2])

Parameters

l	The vector layer for which this configuration is
t	Which parts of the geometry should be snappable
tol	The tolerance radius in which the snapping will trigger
u	The unit in which the tolerance is specified

Definition at line 141 of file qgssnappingutils.h.

Member Function Documentation

operator!=()

bool QgsSnappingUtils::LayerConfig::operator!= ( const QgsSnappingUtils::LayerConfig &  other ) const

inline

Definition at line 153 of file qgssnappingutils.h.

operator==()

bool QgsSnappingUtils::LayerConfig::operator== ( const QgsSnappingUtils::LayerConfig &  other ) const

inline

Definition at line 149 of file qgssnappingutils.h.

Member Data Documentation

layer

QgsVectorLayer* QgsSnappingUtils::LayerConfig::layer = nullptr

The layer to configure.

Definition at line 159 of file qgssnappingutils.h.

tolerance

double QgsSnappingUtils::LayerConfig::tolerance

The range around snapping targets in which snapping should occur.

Definition at line 163 of file qgssnappingutils.h.

type

QgsPointLocator::Types QgsSnappingUtils::LayerConfig::type

To which geometry properties of this layers a snapping should happen.

Definition at line 161 of file qgssnappingutils.h.

unit

Qgis::MapToolUnit QgsSnappingUtils::LayerConfig::unit

The units in which the tolerance is specified.

Definition at line 165 of file qgssnappingutils.h.

---

The documentation for this struct was generated from the following file:

• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/qgssnappingutils.h