QGIS API Documentation
3.0.2-Girona (307d082)
|
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 | SnappingMode { ActiveLayer = 1, AllLayers = 2, AdvancedConfiguration = 3 } |
SnappingMode defines on which layer the snapping is performed. 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... | |
bool | enabled () const |
return if snapping is enabled More... | |
QHash< QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings > | individualLayerSettings () const |
return individual snapping settings for all layers More... | |
QgsSnappingConfig::IndividualLayerSettings | individualLayerSettings (QgsVectorLayer *vl) const |
return individual layer snappings settings (applied if mode is AdvancedConfiguration) More... | |
bool | intersectionSnapping () const |
return if the snapping on intersection is enabled More... | |
SnappingMode | mode () const |
return 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... | |
Q_ENUM (SnappingMode) | |
Q_ENUM (SnappingType) | |
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... | |
void | setEnabled (bool enabled) |
enables the snapping More... | |
void | setIndividualLayerSettings (QgsVectorLayer *vl, const QgsSnappingConfig::IndividualLayerSettings &individualLayerSettings) |
set individual layer snappings settings (applied if mode is AdvancedConfiguration) More... | |
void | setIntersectionSnapping (bool enabled) |
set if the snapping on intersection is enabled More... | |
void | setMode (SnappingMode mode) |
define the mode of snapping More... | |
void | setProject (QgsProject *project) |
The project from which the snapped layers should be retrieved. More... | |
void | setTolerance (double tolerance) |
set the tolerance More... | |
void | setType (SnappingType type) |
define the type of snapping More... | |
void | setUnits (QgsTolerance::UnitType units) |
set the type of units More... | |
double | tolerance () const |
return the tolerance More... | |
SnappingType | type () const |
return the type (vertices and/or segments) More... | |
QgsTolerance::UnitType | units () const |
return the type of units More... | |
void | writeProject (QDomDocument &doc) |
Writes the configuration to the specified QGIS project document. More... | |
Properties | |
QgsProject | project |
This is a container for configuration of the snapping of the project.
Definition at line 34 of file qgssnappingconfig.h.
SnappingMode defines on which layer the snapping is performed.
Enumerator | |
---|---|
ActiveLayer | On the active layer. |
AllLayers | On all vector layers. |
AdvancedConfiguration | On a per layer configuration basis. |
Definition at line 45 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 56 of file qgssnappingconfig.h.
|
explicit |
Constructor with default parameters defined in global settings.
Definition at line 99 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.
Definition at line 367 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::enabled | ( | ) | const |
return if snapping is enabled
Definition at line 160 of file qgssnappingconfig.cpp.
QHash< QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings > QgsSnappingConfig::individualLayerSettings | ( | ) | const |
return individual snapping settings for all layers
Definition at line 240 of file qgssnappingconfig.cpp.
QgsSnappingConfig::IndividualLayerSettings QgsSnappingConfig::individualLayerSettings | ( | QgsVectorLayer * | vl | ) | const |
return individual layer snappings settings (applied if mode is AdvancedConfiguration)
Definition at line 245 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::intersectionSnapping | ( | ) | const |
return if the snapping on intersection is enabled
Definition at line 230 of file qgssnappingconfig.cpp.
QgsSnappingConfig::SnappingMode QgsSnappingConfig::mode | ( | ) | const |
return the mode (all layers, active layer, per layer settings)
Definition at line 174 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::operator!= | ( | const QgsSnappingConfig & | other | ) | const |
Compare this configuration to other.
Definition at line 267 of file qgssnappingconfig.cpp.
bool QgsSnappingConfig::operator== | ( | const QgsSnappingConfig & | other | ) | const |
Definition at line 106 of file qgssnappingconfig.cpp.
QgsProject* QgsSnappingConfig::project | ( | ) | const |
The project from which the snapped layers should be retrieved.
QgsSnappingConfig::Q_ENUM | ( | SnappingMode | ) |
QgsSnappingConfig::Q_ENUM | ( | SnappingType | ) |
void QgsSnappingConfig::readProject | ( | const QDomDocument & | doc | ) |
Reads the configuration from the specified QGIS project document.
Definition at line 277 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.
Definition at line 387 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::reset | ( | ) |
reset to default values
Definition at line 117 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setEnabled | ( | bool | enabled | ) |
enables the snapping
Definition at line 165 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setIndividualLayerSettings | ( | QgsVectorLayer * | vl, |
const QgsSnappingConfig::IndividualLayerSettings & | individualLayerSettings | ||
) |
set individual layer snappings settings (applied if mode is AdvancedConfiguration)
Definition at line 258 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setIntersectionSnapping | ( | bool | enabled | ) |
set if the snapping on intersection is enabled
Definition at line 235 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setMode | ( | QgsSnappingConfig::SnappingMode | mode | ) |
define the mode of snapping
Definition at line 179 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setProject | ( | QgsProject * | project | ) |
The project from which the snapped layers should be retrieved.
Definition at line 476 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setTolerance | ( | double | tolerance | ) |
set the tolerance
Definition at line 207 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setType | ( | QgsSnappingConfig::SnappingType | type | ) |
define the type of snapping
Definition at line 193 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::setUnits | ( | QgsTolerance::UnitType | units | ) |
set the type of units
Definition at line 221 of file qgssnappingconfig.cpp.
double QgsSnappingConfig::tolerance | ( | ) | const |
return the tolerance
Definition at line 202 of file qgssnappingconfig.cpp.
QgsSnappingConfig::SnappingType QgsSnappingConfig::type | ( | ) | const |
return the type (vertices and/or segments)
Definition at line 188 of file qgssnappingconfig.cpp.
QgsTolerance::UnitType QgsSnappingConfig::units | ( | ) | const |
return the type of units
Definition at line 216 of file qgssnappingconfig.cpp.
void QgsSnappingConfig::writeProject | ( | QDomDocument & | doc | ) |
Writes the configuration to the specified QGIS project document.
Definition at line 338 of file qgssnappingconfig.cpp.
|
readwrite |
Definition at line 38 of file qgssnappingconfig.h.