QGIS API Documentation  3.9.0-Master (6d389215ab)
Signals | Public Member Functions | List of all members
QgsGeometryOptions Class Reference

The QgsGeometryOptions class contains options to automatically adjust geometries to constraints on a layer. More...

#include <qgsgeometryoptions.h>

Inheritance diagram for QgsGeometryOptions:
Inheritance graph
[legend]

Signals

void checkConfigurationChanged ()
 Access the configuration for the check checkId. More...
 
void geometryChecksChanged ()
 A list of activated geometry checks. More...
 
void geometryPrecisionChanged ()
 The precision in which geometries on this layer should be saved. More...
 
void removeDuplicateNodesChanged ()
 Automatically remove duplicate nodes on all geometries which are edited on this layer. More...
 

Public Member Functions

 QgsGeometryOptions ()
 Create a new QgsGeometryOptions object. More...
 
void apply (QgsGeometry &geometry) const
 Apply any fixes configured on this class to geometry. More...
 
QVariantMap checkConfiguration (const QString &checkId) const
 Access the configuration for the check checkId. More...
 
QStringList geometryChecks () const
 A list of activated geometry checks. More...
 
double geometryPrecision () const
 The precision in which geometries on this layer should be saved. More...
 
bool isActive () const
 Determines if at least one fix is enabled. More...
 
void readXml (const QDomNode &node)
 Read the geometry options from node. More...
 
bool removeDuplicateNodes () const
 Automatically remove duplicate nodes on all geometries which are edited on this layer. More...
 
void setCheckConfiguration (const QString &checkId, const QVariantMap &checkConfiguration)
 Set the configuration for the check checkId. More...
 
void setGeometryChecks (const QStringList &geometryChecks)
 A list of activated geometry checks. More...
 
void setGeometryPrecision (double value)
 The precision in which geometries on this layer should be saved. More...
 
void setRemoveDuplicateNodes (bool value)
 Automatically remove duplicate nodes on all geometries which are edited on this layer. More...
 
void writeXml (QDomNode &node) const
 Write the geometry options to the node. More...
 

Detailed Description

The QgsGeometryOptions class contains options to automatically adjust geometries to constraints on a layer.

Since
QGIS 3.4

Definition at line 35 of file qgsgeometryoptions.h.

Constructor & Destructor Documentation

◆ QgsGeometryOptions()

QgsGeometryOptions::QgsGeometryOptions ( )

Create a new QgsGeometryOptions object.

Definition at line 24 of file qgsgeometryoptions.cpp.

Member Function Documentation

◆ apply()

void QgsGeometryOptions::apply ( QgsGeometry geometry) const

Apply any fixes configured on this class to geometry.

Since
QGIS 3.4

Definition at line 56 of file qgsgeometryoptions.cpp.

◆ checkConfiguration()

QVariantMap QgsGeometryOptions::checkConfiguration ( const QString &  checkId) const

Access the configuration for the check checkId.

Since
QGIS 3.4

Definition at line 76 of file qgsgeometryoptions.cpp.

◆ checkConfigurationChanged

void QgsGeometryOptions::checkConfigurationChanged ( )
signal

Access the configuration for the check checkId.

Since
QGIS 3.4

◆ geometryChecks()

QStringList QgsGeometryOptions::geometryChecks ( ) const

A list of activated geometry checks.

Since
QGIS 3.4

Definition at line 65 of file qgsgeometryoptions.cpp.

◆ geometryChecksChanged

void QgsGeometryOptions::geometryChecksChanged ( )
signal

A list of activated geometry checks.

Since
QGIS 3.4

◆ geometryPrecision()

double QgsGeometryOptions::geometryPrecision ( ) const

The precision in which geometries on this layer should be saved.

Geometries which are edited on this layer will be rounded to multiples of this value (snap to grid). Set to 0.0 to disable.

Since
QGIS 3.4

Definition at line 40 of file qgsgeometryoptions.cpp.

◆ geometryPrecisionChanged

void QgsGeometryOptions::geometryPrecisionChanged ( )
signal

The precision in which geometries on this layer should be saved.

Geometries which are edited on this layer will be rounded to multiples of this value (snap to grid). Set to 0.0 to disable.

Since
QGIS 3.4

◆ isActive()

bool QgsGeometryOptions::isActive ( ) const

Determines if at least one fix is enabled.

Since
QGIS 3.4

Definition at line 51 of file qgsgeometryoptions.cpp.

◆ readXml()

void QgsGeometryOptions::readXml ( const QDomNode &  node)

Read the geometry options from node.

Since
QGIS 3.4

Definition at line 104 of file qgsgeometryoptions.cpp.

◆ removeDuplicateNodes()

bool QgsGeometryOptions::removeDuplicateNodes ( ) const

Automatically remove duplicate nodes on all geometries which are edited on this layer.

Since
QGIS 3.4

Definition at line 29 of file qgsgeometryoptions.cpp.

◆ removeDuplicateNodesChanged

void QgsGeometryOptions::removeDuplicateNodesChanged ( )
signal

Automatically remove duplicate nodes on all geometries which are edited on this layer.

Since
QGIS 3.4

◆ setCheckConfiguration()

void QgsGeometryOptions::setCheckConfiguration ( const QString &  checkId,
const QVariantMap &  checkConfiguration 
)

Set the configuration for the check checkId.

Since
QGIS 3.4

Definition at line 81 of file qgsgeometryoptions.cpp.

◆ setGeometryChecks()

void QgsGeometryOptions::setGeometryChecks ( const QStringList &  geometryChecks)

A list of activated geometry checks.

Since
QGIS 3.4

Definition at line 70 of file qgsgeometryoptions.cpp.

◆ setGeometryPrecision()

void QgsGeometryOptions::setGeometryPrecision ( double  value)

The precision in which geometries on this layer should be saved.

Geometries which are edited on this layer will be rounded to multiples of this value (snap to grid). Set to 0.0 to disable.

Since
QGIS 3.4

Definition at line 45 of file qgsgeometryoptions.cpp.

◆ setRemoveDuplicateNodes()

void QgsGeometryOptions::setRemoveDuplicateNodes ( bool  value)

Automatically remove duplicate nodes on all geometries which are edited on this layer.

Since
QGIS 3.4

Definition at line 34 of file qgsgeometryoptions.cpp.

◆ writeXml()

void QgsGeometryOptions::writeXml ( QDomNode &  node) const

Write the geometry options to the node.

Since
QGIS 3.4

Definition at line 87 of file qgsgeometryoptions.cpp.


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