QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
|
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::IndividualLayerSettings > | individualLayerSettings () 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 |
QgsProject * | project () 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 (Qgis::MapToolUnit 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... | |
Qgis::MapToolUnit | 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 QgsProject * | project |
This is a container for configuration of the snapping of the project.
Definition at line 37 of file qgssnappingconfig.h.
ScaleDependencyMode the scale dependency mode of snapping.
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 defines on what object the snapping is performed.
Enumerator | |
---|---|
Vertex | On vertices only. |
VertexAndSegment | Both on vertices and segments. |
Segment | On segments only. |
Definition at line 49 of file qgssnappingconfig.h.
|
explicit |
Constructor with default parameters defined in global settings.
Definition at line 168 of file qgssnappingconfig.cpp.
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.
true
if changes have been done.Definition at line 592 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::clearIndividualLayerSettings | ( | ) |
Removes all individual layer snapping settings.
Definition at line 415 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::enabled | ( | ) | const |
Returns if snapping is enabled.
Definition at line 235 of file qgssnappingconfig.cpp.
QHash< QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings > QgsSnappingConfig::individualLayerSettings | ( | ) | const |
Returns individual snapping settings for all layers.
Definition at line 397 of file qgssnappingconfig.cpp.
QgsSnappingConfig::IndividualLayerSettings QgsSnappingConfig::individualLayerSettings | ( | QgsVectorLayer * | vl | ) | const |
Returns individual layer snappings settings (applied if mode is AdvancedConfiguration)
Definition at line 402 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::intersectionSnapping | ( | ) | const |
Returns if the snapping on intersection is enabled.
Definition at line 377 of file qgssnappingconfig.cpp.
double QgsSnappingConfig::maximumScale | ( | ) | const |
Returns the max scale (i.e.
most "zoomed in" scale)
Definition at line 721 of file qgssnappingconfig.cpp.
double QgsSnappingConfig::minimumScale | ( | ) | const |
Returns the min scale (i.e.
most "zoomed out" scale)
Definition at line 711 of file qgssnappingconfig.cpp.
Qgis::SnappingMode QgsSnappingConfig::mode | ( | ) | const |
Returns the mode (all layers, active layer, per layer settings)
Definition at line 249 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::operator!= | ( | const QgsSnappingConfig & | other | ) | const |
Compare this configuration to other.
Definition at line 429 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::operator== | ( | const QgsSnappingConfig & | other | ) | const |
Definition at line 175 of file qgssnappingconfig.cpp.
QgsProject * QgsSnappingConfig::project | ( | ) | const |
The project from which the snapped layers should be retrieved.
Definition at line 698 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::readProject | ( | const QDomDocument & | doc | ) |
Reads the configuration from the specified QGIS project document.
Definition at line 442 of file qgssnappingconfig.cpp.
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.
true
if changes have been done.Definition at line 613 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::reset | ( | ) |
reset to default values
Definition at line 190 of file qgssnappingconfig.cpp.
QgsSnappingConfig::ScaleDependencyMode QgsSnappingConfig::scaleDependencyMode | ( | ) | const |
Returns the scale dependency mode.
Definition at line 736 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::selfSnapping | ( | ) | const |
Returns if self snapping (snapping to the currently digitized feature) is enabled.
Definition at line 387 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setEnabled | ( | bool | enabled | ) |
enables the snapping
Definition at line 240 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setIndividualLayerSettings | ( | QgsVectorLayer * | vl, |
const QgsSnappingConfig::IndividualLayerSettings & | individualLayerSettings | ||
) |
Sets individual layer snappings settings (applied if mode is AdvancedConfiguration)
Definition at line 420 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setIntersectionSnapping | ( | bool | enabled | ) |
Sets if the snapping on intersection is enabled.
Definition at line 382 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setMaximumScale | ( | double | maxScale | ) |
Set the max scale on which snapping is enabled, 0.0 disable scale limit.
Definition at line 726 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setMinimumScale | ( | double | minScale | ) |
Sets the min scale on which snapping is enabled, 0.0 disable scale limit.
Definition at line 716 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setMode | ( | Qgis::SnappingMode | mode | ) |
define the mode of snapping
Definition at line 254 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setProject | ( | QgsProject * | project | ) |
The project from which the snapped layers should be retrieved.
Definition at line 703 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setScaleDependencyMode | ( | QgsSnappingConfig::ScaleDependencyMode | mode | ) |
void QgsSnappingConfig::setSelfSnapping | ( | bool | enabled | ) |
Sets if self snapping (snapping to the currently digitized feature) is enabled.
Definition at line 392 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setTolerance | ( | double | tolerance | ) |
Sets the tolerance.
Definition at line 354 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setType | ( | QgsSnappingConfig::SnappingType | type | ) |
define the type of snapping
Definition at line 322 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setTypeFlag | ( | Qgis::SnappingTypes | type | ) |
void QgsSnappingConfig::setUnits | ( | Qgis::MapToolUnit | units | ) |
Sets the type of units.
Definition at line 368 of file qgssnappingconfig.cpp.
|
inlinestatic |
Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes.
Definition at line 100 of file qgssnappingconfig.h.
|
inlinestatic |
Convenient method to return the translated name of the enum type Qgis::SnappingTypes.
Definition at line 84 of file qgssnappingconfig.h.
|
static |
Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes.
Definition at line 300 of file qgssnappingconfig.cpp.
|
static |
Convenient method to returns the translated name of the enum type Qgis::SnappingTypes.
Definition at line 278 of file qgssnappingconfig.cpp.
double QgsSnappingConfig::tolerance | ( | ) | const |
Returns the tolerance.
Definition at line 349 of file qgssnappingconfig.cpp.
QgsSnappingConfig::SnappingType QgsSnappingConfig::type | ( | ) | const |
Returns the flags type (vertices | segments | area | centroid | middle)
Definition at line 268 of file qgssnappingconfig.cpp.
Qgis::SnappingTypes QgsSnappingConfig::typeFlag | ( | ) | const |
Returns the flags type (vertices | segments | area | centroid | middle)
Definition at line 263 of file qgssnappingconfig.cpp.
Qgis::MapToolUnit QgsSnappingConfig::units | ( | ) | const |
Returns the type of units.
Definition at line 363 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::writeProject | ( | QDomDocument & | doc | ) |
Writes the configuration to the specified QGIS project document.
Definition at line 557 of file qgssnappingconfig.cpp.
|
readwrite |
Definition at line 39 of file qgssnappingconfig.h.