QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Public Attributes | List of all members
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, QgsTolerance::UnitType u)
 Create a new configuration for a snapping layer. More...
 
bool operator!= (const LayerConfig &other) const
 
bool operator== (const LayerConfig &other) const
 

Public Attributes

QgsVectorLayerlayer
 The layer to configure. More...
 
double tolerance
 The range around snapping targets in which snapping should occur. More...
 
QgsPointLocator::Types type
 To which geometry properties of this layers a snapping should happen. More...
 
QgsTolerance::UnitType unit
 The units in which the tolerance is specified. More...
 

Detailed Description

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

Definition at line 108 of file qgssnappingutils.h.

Constructor & Destructor Documentation

QgsSnappingUtils::LayerConfig::LayerConfig ( QgsVectorLayer l,
QgsPointLocator::Types  t,
double  tol,
QgsTolerance::UnitType  u 
)
inline

Create a new configuration for a snapping layer.

1 snapper = QgsMapCanvasSnappingUtils(mapCanvas)
2 
3 snapping_layer1 = QgsSnappingUtils.LayerConfig(layer1, QgsPointLocator.Vertex, 10, QgsTolerance.Pixels)
4 snapping_layer2 = QgsSnappingUtils.LayerConfig(layer2, QgsPointLocator.Vertex and QgsPointLocator.Edge, 10, QgsTolerance.Pixels)
5 
6 snapper.setLayers([snapping_layer1, snapping_layer2])
7 snapper.setSnapToMapMode(QgsSnappingUtils.SnapAdvanced)
Parameters
lThe vector layer for which this configuration is
tWhich parts of the geometry should be snappable
tolThe tolerance radius in which the snapping will trigger
uThe unit in which the tolerance is specified

Definition at line 128 of file qgssnappingutils.h.

Member Function Documentation

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

Definition at line 139 of file qgssnappingutils.h.

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

Definition at line 135 of file qgssnappingutils.h.

Member Data Documentation

QgsVectorLayer* QgsSnappingUtils::LayerConfig::layer

The layer to configure.

Definition at line 145 of file qgssnappingutils.h.

double QgsSnappingUtils::LayerConfig::tolerance

The range around snapping targets in which snapping should occur.

Definition at line 149 of file qgssnappingutils.h.

QgsPointLocator::Types QgsSnappingUtils::LayerConfig::type

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

Definition at line 147 of file qgssnappingutils.h.

QgsTolerance::UnitType QgsSnappingUtils::LayerConfig::unit

The units in which the tolerance is specified.

Definition at line 151 of file qgssnappingutils.h.


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