QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Classes | Public Types | Public Member Functions | Static Public Member Functions | Properties | List of all members
QgsSnappingConfig Class Reference

This is a container for configuration of the snapping of the project. More...

#include <qgssnappingconfig.h>

Classes

class  IndividualLayerSettings
 This is a container of advanced configuration (per layer) of the snapping of the project. More...
 

Public Types

enum  ScaleDependencyMode { Disabled = 0 , Global = 1 , PerLayer = 2 }
 ScaleDependencyMode the scale dependency mode of snapping. More...
 
enum  SnappingType { Vertex = 1 , VertexAndSegment = 2 , Segment = 3 }
 SnappingType defines on what object the snapping is performed. More...
 

Public Member Functions

 QgsSnappingConfig (QgsProject *project=nullptr)
 Constructor with default parameters defined in global settings. More...
 
bool addLayers (const QList< QgsMapLayer * > &layers)
 Adds the specified layers as individual layers to the configuration with standard configuration. More...
 
void clearIndividualLayerSettings ()
 Removes all individual layer snapping settings. More...
 
bool enabled () const
 Returns if snapping is enabled. More...
 
QHash< QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettingsindividualLayerSettings () const
 Returns individual snapping settings for all layers. More...
 
QgsSnappingConfig::IndividualLayerSettings individualLayerSettings (QgsVectorLayer *vl) const
 Returns individual layer snappings settings (applied if mode is AdvancedConfiguration) More...
 
bool intersectionSnapping () const
 Returns if the snapping on intersection is enabled. More...
 
double maximumScale () const
 Returns the max scale (i.e. More...
 
double minimumScale () const
 Returns the min scale (i.e. More...
 
Qgis::SnappingMode mode () const
 Returns the mode (all layers, active layer, per layer settings) More...
 
bool operator!= (const QgsSnappingConfig &other) const
 Compare this configuration to other. More...
 
bool operator== (const QgsSnappingConfig &other) const
 
QgsProjectproject () const
 The project from which the snapped layers should be retrieved. More...
 
void readProject (const QDomDocument &doc)
 Reads the configuration from the specified QGIS project document. More...
 
bool removeLayers (const QList< QgsMapLayer * > &layers)
 Removes the specified layers from the individual layer configuration. More...
 
void reset ()
 reset to default values More...
 
ScaleDependencyMode scaleDependencyMode () const
 Returns the scale dependency mode. More...
 
bool selfSnapping () const
 Returns if self snapping (snapping to the currently digitized feature) is enabled. More...
 
void setEnabled (bool enabled)
 enables the snapping More...
 
void setIndividualLayerSettings (QgsVectorLayer *vl, const QgsSnappingConfig::IndividualLayerSettings &individualLayerSettings)
 Sets individual layer snappings settings (applied if mode is AdvancedConfiguration) More...
 
void setIntersectionSnapping (bool enabled)
 Sets if the snapping on intersection is enabled. More...
 
void setMaximumScale (double maxScale)
 Set the max scale on which snapping is enabled, 0.0 disable scale limit. More...
 
void setMinimumScale (double minScale)
 Sets the min scale on which snapping is enabled, 0.0 disable scale limit. More...
 
void setMode (Qgis::SnappingMode mode)
 define the mode of snapping More...
 
void setProject (QgsProject *project)
 The project from which the snapped layers should be retrieved. More...
 
void setScaleDependencyMode (ScaleDependencyMode mode)
 Set the scale dependency mode. More...
 
void setSelfSnapping (bool enabled)
 Sets if self snapping (snapping to the currently digitized feature) is enabled. More...
 
void setTolerance (double tolerance)
 Sets the tolerance. More...
 
Q_DECL_DEPRECATED void setType (QgsSnappingConfig::SnappingType type)
 define the type of snapping More...
 
void setTypeFlag (Qgis::SnappingTypes type)
 define the type of snapping More...
 
void setUnits (QgsTolerance::UnitType units)
 Sets the type of units. More...
 
double tolerance () const
 Returns the tolerance. More...
 
Q_DECL_DEPRECATED QgsSnappingConfig::SnappingType type () const
 Returns the flags type (vertices | segments | area | centroid | middle) More...
 
Qgis::SnappingTypes typeFlag () const
 Returns the flags type (vertices | segments | area | centroid | middle) More...
 
QgsTolerance::UnitType units () const
 Returns the type of units. More...
 
void writeProject (QDomDocument &doc)
 Writes the configuration to the specified QGIS project document. More...
 

Static Public Member Functions

static Q_DECL_DEPRECATED QIcon snappingTypeFlagToIcon (Qgis::SnappingType type)
 Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes. More...
 
static Q_DECL_DEPRECATED QString snappingTypeFlagToString (Qgis::SnappingType type)
 Convenient method to return the translated name of the enum type Qgis::SnappingTypes. More...
 
static QIcon snappingTypeToIcon (Qgis::SnappingType type)
 Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes. More...
 
static QString snappingTypeToString (Qgis::SnappingType type)
 Convenient method to returns the translated name of the enum type Qgis::SnappingTypes. More...
 

Properties

Q_GADGET QgsProjectproject
 

Detailed Description

This is a container for configuration of the snapping of the project.

Since
QGIS 3.0

Definition at line 37 of file qgssnappingconfig.h.

Member Enumeration Documentation

◆ ScaleDependencyMode

ScaleDependencyMode the scale dependency mode of snapping.

Since
QGIS 3.14
Enumerator
Disabled 

No scale dependency.

Global 

Scale dependency using global min max range.

PerLayer 

Scale dependency using min max range per layer.

Definition at line 63 of file qgssnappingconfig.h.

◆ SnappingType

SnappingType defines on what object the snapping is performed.

Deprecated:
since QGIS 3.12 use Qgis::SnappingTypes instead.
Enumerator
Vertex 

On vertices only.

VertexAndSegment 

Both on vertices and segments.

Segment 

On segments only.

Definition at line 49 of file qgssnappingconfig.h.

Constructor & Destructor Documentation

◆ QgsSnappingConfig()

QgsSnappingConfig::QgsSnappingConfig ( QgsProject project = nullptr)
explicit

Constructor with default parameters defined in global settings.

Definition at line 167 of file qgssnappingconfig.cpp.

Member Function Documentation

◆ addLayers()

bool QgsSnappingConfig::addLayers ( const QList< QgsMapLayer * > &  layers)

Adds the specified layers as individual layers to the configuration with standard configuration.

When implementing a long-living QgsSnappingConfig (like the one in QgsProject) it is best to directly feed this with information from the layer registry.

Returns
true if changes have been done.
Since
QGIS 3.0

Definition at line 591 of file qgssnappingconfig.cpp.

◆ clearIndividualLayerSettings()

void QgsSnappingConfig::clearIndividualLayerSettings ( )

Removes all individual layer snapping settings.

Since
QGIS 3.16

Definition at line 414 of file qgssnappingconfig.cpp.

◆ enabled()

bool QgsSnappingConfig::enabled ( ) const

Returns if snapping is enabled.

Definition at line 234 of file qgssnappingconfig.cpp.

◆ individualLayerSettings() [1/2]

QHash< QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings > QgsSnappingConfig::individualLayerSettings ( ) const

Returns individual snapping settings for all layers.

Definition at line 396 of file qgssnappingconfig.cpp.

◆ individualLayerSettings() [2/2]

QgsSnappingConfig::IndividualLayerSettings QgsSnappingConfig::individualLayerSettings ( QgsVectorLayer vl) const

Returns individual layer snappings settings (applied if mode is AdvancedConfiguration)

Definition at line 401 of file qgssnappingconfig.cpp.

◆ intersectionSnapping()

bool QgsSnappingConfig::intersectionSnapping ( ) const

Returns if the snapping on intersection is enabled.

Definition at line 376 of file qgssnappingconfig.cpp.

◆ maximumScale()

double QgsSnappingConfig::maximumScale ( ) const

Returns the max scale (i.e.

most "zoomed in" scale)

Since
QGIS 3.14

Definition at line 720 of file qgssnappingconfig.cpp.

◆ minimumScale()

double QgsSnappingConfig::minimumScale ( ) const

Returns the min scale (i.e.

most "zoomed out" scale)

Since
QGIS 3.14

Definition at line 710 of file qgssnappingconfig.cpp.

◆ mode()

Qgis::SnappingMode QgsSnappingConfig::mode ( ) const

Returns the mode (all layers, active layer, per layer settings)

Definition at line 248 of file qgssnappingconfig.cpp.

◆ operator!=()

bool QgsSnappingConfig::operator!= ( const QgsSnappingConfig other) const

Compare this configuration to other.

Definition at line 428 of file qgssnappingconfig.cpp.

◆ operator==()

bool QgsSnappingConfig::operator== ( const QgsSnappingConfig other) const

Definition at line 174 of file qgssnappingconfig.cpp.

◆ project()

QgsProject * QgsSnappingConfig::project ( ) const

The project from which the snapped layers should be retrieved.

Since
QGIS 3.0

Definition at line 697 of file qgssnappingconfig.cpp.

◆ readProject()

void QgsSnappingConfig::readProject ( const QDomDocument &  doc)

Reads the configuration from the specified QGIS project document.

Since
QGIS 3.0

Definition at line 441 of file qgssnappingconfig.cpp.

◆ removeLayers()

bool QgsSnappingConfig::removeLayers ( const QList< QgsMapLayer * > &  layers)

Removes the specified layers from the individual layer configuration.

When implementing a long-living QgsSnappingConfig (like the one in QgsProject) it is best to directly feed this with information from the layer registry.

Returns
true if changes have been done.
Since
QGIS 3.0

Definition at line 612 of file qgssnappingconfig.cpp.

◆ reset()

void QgsSnappingConfig::reset ( )

reset to default values

Definition at line 189 of file qgssnappingconfig.cpp.

◆ scaleDependencyMode()

QgsSnappingConfig::ScaleDependencyMode QgsSnappingConfig::scaleDependencyMode ( ) const

Returns the scale dependency mode.

Since
QGIS 3.14

Definition at line 735 of file qgssnappingconfig.cpp.

◆ selfSnapping()

bool QgsSnappingConfig::selfSnapping ( ) const

Returns if self snapping (snapping to the currently digitized feature) is enabled.

Since
QGIS 3.14

Definition at line 386 of file qgssnappingconfig.cpp.

◆ setEnabled()

void QgsSnappingConfig::setEnabled ( bool  enabled)

enables the snapping

Definition at line 239 of file qgssnappingconfig.cpp.

◆ setIndividualLayerSettings()

void QgsSnappingConfig::setIndividualLayerSettings ( QgsVectorLayer vl,
const QgsSnappingConfig::IndividualLayerSettings individualLayerSettings 
)

Sets individual layer snappings settings (applied if mode is AdvancedConfiguration)

Definition at line 419 of file qgssnappingconfig.cpp.

◆ setIntersectionSnapping()

void QgsSnappingConfig::setIntersectionSnapping ( bool  enabled)

Sets if the snapping on intersection is enabled.

Definition at line 381 of file qgssnappingconfig.cpp.

◆ setMaximumScale()

void QgsSnappingConfig::setMaximumScale ( double  maxScale)

Set the max scale on which snapping is enabled, 0.0 disable scale limit.

Since
QGIS 3.14

Definition at line 725 of file qgssnappingconfig.cpp.

◆ setMinimumScale()

void QgsSnappingConfig::setMinimumScale ( double  minScale)

Sets the min scale on which snapping is enabled, 0.0 disable scale limit.

Since
QGIS 3.14

Definition at line 715 of file qgssnappingconfig.cpp.

◆ setMode()

void QgsSnappingConfig::setMode ( Qgis::SnappingMode  mode)

define the mode of snapping

Definition at line 253 of file qgssnappingconfig.cpp.

◆ setProject()

void QgsSnappingConfig::setProject ( QgsProject project)

The project from which the snapped layers should be retrieved.

Since
QGIS 3.0

Definition at line 702 of file qgssnappingconfig.cpp.

◆ setScaleDependencyMode()

void QgsSnappingConfig::setScaleDependencyMode ( QgsSnappingConfig::ScaleDependencyMode  mode)

Set the scale dependency mode.

Since
QGIS 3.14

Definition at line 730 of file qgssnappingconfig.cpp.

◆ setSelfSnapping()

void QgsSnappingConfig::setSelfSnapping ( bool  enabled)

Sets if self snapping (snapping to the currently digitized feature) is enabled.

Since
QGIS 3.14

Definition at line 391 of file qgssnappingconfig.cpp.

◆ setTolerance()

void QgsSnappingConfig::setTolerance ( double  tolerance)

Sets the tolerance.

Definition at line 353 of file qgssnappingconfig.cpp.

◆ setType()

void QgsSnappingConfig::setType ( QgsSnappingConfig::SnappingType  type)

define the type of snapping

Deprecated:
since QGIS 3.12 use setTypeFlag instead.

Definition at line 321 of file qgssnappingconfig.cpp.

◆ setTypeFlag()

void QgsSnappingConfig::setTypeFlag ( Qgis::SnappingTypes  type)

define the type of snapping

Since
QGIS 3.12

Definition at line 339 of file qgssnappingconfig.cpp.

◆ setUnits()

void QgsSnappingConfig::setUnits ( QgsTolerance::UnitType  units)

Sets the type of units.

Definition at line 367 of file qgssnappingconfig.cpp.

◆ snappingTypeFlagToIcon()

static Q_DECL_DEPRECATED QIcon QgsSnappingConfig::snappingTypeFlagToIcon ( Qgis::SnappingType  type)
inlinestatic

Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes.

Deprecated:
since QGIS 3.26 use Qgis::snappingTypeToString instead
Since
QGIS 3.20

Definition at line 100 of file qgssnappingconfig.h.

◆ snappingTypeFlagToString()

static Q_DECL_DEPRECATED QString QgsSnappingConfig::snappingTypeFlagToString ( Qgis::SnappingType  type)
inlinestatic

Convenient method to return the translated name of the enum type Qgis::SnappingTypes.

Since
QGIS 3.12
Deprecated:
since QGIS 3.26 use Qgis::snappingTypeToString instead

Definition at line 84 of file qgssnappingconfig.h.

◆ snappingTypeToIcon()

QIcon QgsSnappingConfig::snappingTypeToIcon ( Qgis::SnappingType  type)
static

Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes.

Since
QGIS 3.20

Definition at line 299 of file qgssnappingconfig.cpp.

◆ snappingTypeToString()

QString QgsSnappingConfig::snappingTypeToString ( Qgis::SnappingType  type)
static

Convenient method to returns the translated name of the enum type Qgis::SnappingTypes.

Since
QGIS 3.26

Definition at line 277 of file qgssnappingconfig.cpp.

◆ tolerance()

double QgsSnappingConfig::tolerance ( ) const

Returns the tolerance.

Definition at line 348 of file qgssnappingconfig.cpp.

◆ type()

QgsSnappingConfig::SnappingType QgsSnappingConfig::type ( ) const

Returns the flags type (vertices | segments | area | centroid | middle)

Deprecated:
since QGIS 3.12 use typeFlag instead.

Definition at line 267 of file qgssnappingconfig.cpp.

◆ typeFlag()

Qgis::SnappingTypes QgsSnappingConfig::typeFlag ( ) const

Returns the flags type (vertices | segments | area | centroid | middle)

Since
QGIS 3.12

Definition at line 262 of file qgssnappingconfig.cpp.

◆ units()

QgsTolerance::UnitType QgsSnappingConfig::units ( ) const

Returns the type of units.

Definition at line 362 of file qgssnappingconfig.cpp.

◆ writeProject()

void QgsSnappingConfig::writeProject ( QDomDocument &  doc)

Writes the configuration to the specified QGIS project document.

Since
QGIS 3.0

Definition at line 556 of file qgssnappingconfig.cpp.

Property Documentation

◆ project

Q_GADGET QgsProject * QgsSnappingConfig::project
readwrite

Definition at line 39 of file qgssnappingconfig.h.


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