Merge pull request #7959 from m-kuhn/geometryOptions

Add a new QML category "Geometry Options"

Author: m-kuhn

python/core/auto_generated/qgsgeometryfixes.sip.in python/core/auto_generated/qgsgeometryoptions.sip.in

@@ -1,32 +1,32 @@
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
- * src/core/qgsgeometryfixes.h                                          *
+ * src/core/qgsgeometryoptions.h                                        *
  *                                                                      *
  * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
  ************************************************************************/
 
 
 
 
-class QgsGeometryFixes
+class QgsGeometryOptions
 {
 %Docstring
 
-The QgsGeometryFixes class contains options to automatically adjust geometries to
+The QgsGeometryOptions class contains options to automatically adjust geometries to
 constraints on a layer.
 
 .. versionadded:: 3.4
 %End
 
 %TypeHeaderCode
-#include "qgsgeometryfixes.h"
+#include "qgsgeometryoptions.h"
 %End
   public:
 
-    QgsGeometryFixes();
+    QgsGeometryOptions();
 %Docstring
-Create a new QgsGeometryFixes object.
+Create a new QgsGeometryOptions object.
 %End
 
     bool removeDuplicateNodes() const;
@@ -72,6 +72,20 @@ Determines if at least one fix is enabled.
 %Docstring
 Apply any fixes configured on this class to ``geometry``.
 
+.. versionadded:: 3.4
+%End
+
+    void writeXml( QDomNode &node ) const;
+%Docstring
+Write the geometry options to the ``node``.
+
+.. versionadded:: 3.4
+%End
+
+    void readXml( const QDomNode &node );
+%Docstring
+Read the geometry options from ``node``.
+
 .. versionadded:: 3.4
 %End
 
@@ -80,7 +94,7 @@ Apply any fixes configured on this class to ``geometry``.
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
- * src/core/qgsgeometryfixes.h                                          *
+ * src/core/qgsgeometryoptions.h                                        *
  *                                                                      *
  * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
  ************************************************************************/

python/core/auto_generated/qgsmaplayer.sip.in

@@ -89,6 +89,7 @@ This is the base class for all map layer types (vector, raster).
       AttributeTable,
       Rendering,
       CustomProperties,
+      GeometryOptions,
       AllStyleCategories
     };
     typedef QFlags<QgsMapLayer::StyleCategory> StyleCategories;

python/core/auto_generated/qgsvectorlayer.sip.in

@@ -2230,7 +2230,7 @@ Test if an edit command is active
 .. versionadded:: 3.0
 %End
 
-    QgsGeometryFixes *geometryFixes() const;
+    QgsGeometryOptions *geometryOptions() const;
 %Docstring
 Configuration and logic to apply automatically on any edit happening on this layer.
 

python/core/core_auto.sip

@@ -54,7 +54,7 @@
 %Include auto_generated/qgsfields.sip
 %Include auto_generated/qgsfileutils.sip
 %Include auto_generated/qgsfontutils.sip
-%Include auto_generated/qgsgeometryfixes.sip
+%Include auto_generated/qgsgeometryoptions.sip
 %Include auto_generated/qgsgeometrysimplifier.sip
 %Include auto_generated/qgshistogram.sip
 %Include auto_generated/qgshstoreutils.sip

src/app/qgsmaplayerstylecategoriesmodel.cpp

@@ -208,6 +208,17 @@ QVariant QgsMapLayerStyleCategoriesModel::data( const QModelIndex &index, int ro
           return QgsApplication::getThemeIcon( QStringLiteral( "/mActionOptions.svg" ) );
       }
       break;
+    case QgsMapLayer::GeometryOptions:
+      switch ( role )
+      {
+        case Qt::DisplayRole:
+          return tr( "Geometry Options" );
+        case Qt::ToolTipRole:
+          return tr( "Geometry constraints and validity checks" );
+        case Qt::DecorationRole:
+          return QgsApplication::getThemeIcon( QStringLiteral( "/propertyicons/digitizing.svg" ) );
+      }
+      break;
     case QgsMapLayer::AllStyleCategories:
       switch ( role )
       {

src/app/qgsvectorlayerproperties.cpp

@@ -60,7 +60,7 @@
 #include "qgsnewauxiliaryfielddialog.h"
 #include "qgslabelinggui.h"
 #include "qgssymbollayer.h"
-#include "qgsgeometryfixes.h"
+#include "qgsgeometryoptions.h"
 #include "qgsvectorlayersavestyledialog.h"
 #include "qgsvectorlayerloadstyledialog.h"
 
@@ -401,8 +401,8 @@ QgsVectorLayerProperties::QgsVectorLayerProperties(
     mRemoveDuplicateNodesCheckbox->setEnabled( true );
     mGeometryPrecisionSpinBox->setEnabled( true );
 
-    mRemoveDuplicateNodesCheckbox->setChecked( mLayer->geometryFixes()->removeDuplicateNodes() );
-    mGeometryPrecisionSpinBox->setValue( mLayer->geometryFixes()->geometryPrecision() );
+    mRemoveDuplicateNodesCheckbox->setChecked( mLayer->geometryOptions()->removeDuplicateNodes() );
+    mGeometryPrecisionSpinBox->setValue( mLayer->geometryOptions()->geometryPrecision() );
 
     mGeometryPrecisionSpinBox->setSuffix( QStringLiteral( " [%1]" ).arg( QgsUnitTypes::toAbbreviatedString( mLayer->crs().mapUnits() ) ) );
   }
@@ -751,8 +751,8 @@ void QgsVectorLayerProperties::apply()
   mVector3DWidget->apply();
 #endif
 
-  mLayer->geometryFixes()->setRemoveDuplicateNodes( mRemoveDuplicateNodesCheckbox->isChecked() );
-  mLayer->geometryFixes()->setGeometryPrecision( mGeometryPrecisionSpinBox->value() );
+  mLayer->geometryOptions()->setRemoveDuplicateNodes( mRemoveDuplicateNodesCheckbox->isChecked() );
+  mLayer->geometryOptions()->setGeometryPrecision( mGeometryPrecisionSpinBox->value() );
 
   // update symbology
   emit refreshLegend( mLayer->id() );

src/core/CMakeLists.txt

@@ -204,7 +204,7 @@ SET(QGIS_CORE_SRCS
   qgsfontutils.cpp
   qgsgeometrysimplifier.cpp
   qgsgeometryvalidator.cpp
-  qgsgeometryfixes.cpp
+  qgsgeometryoptions.cpp
   qgsgml.cpp
   qgsgmlschema.cpp
   qgshistogram.cpp
@@ -867,7 +867,7 @@ SET(QGIS_CORE_HDRS
   qgsfields.h
   qgsfileutils.h
   qgsfontutils.h
-  qgsgeometryfixes.h
+  qgsgeometryoptions.h
   qgsgeometrysimplifier.h
   qgshistogram.h
   qgshstoreutils.h

src/core/qgsgeometryfixes.cpp src/core/qgsgeometryoptions.cpp

@@ -1,5 +1,5 @@
 /***************************************************************************
-                          qgsgeometryfixes.cpp
+                          qgsgeometryoptions.cpp
                              -------------------
     begin                : Aug 23, 2018
     copyright            : (C) 2018 by Matthias Kuhn
@@ -15,38 +15,56 @@
  *                                                                         *
  ***************************************************************************/
 
-#include "qgsgeometryfixes.h"
+#include "qgsgeometryoptions.h"
 
-bool QgsGeometryFixes::removeDuplicateNodes() const
+#include "qgsxmlutils.h"
+
+bool QgsGeometryOptions::removeDuplicateNodes() const
 {
   return mRemoveDuplicateNodes;
 }
 
-void QgsGeometryFixes::setRemoveDuplicateNodes( bool value )
+void QgsGeometryOptions::setRemoveDuplicateNodes( bool value )
 {
   mRemoveDuplicateNodes = value;
 }
 
-double QgsGeometryFixes::geometryPrecision() const
+double QgsGeometryOptions::geometryPrecision() const
 {
   return mGeometryPrecision;
 }
 
-void QgsGeometryFixes::setGeometryPrecision( double value )
+void QgsGeometryOptions::setGeometryPrecision( double value )
 {
   mGeometryPrecision = value;
 }
 
-bool QgsGeometryFixes::isActive() const
+bool QgsGeometryOptions::isActive() const
 {
   return mGeometryPrecision != 0.0 || mRemoveDuplicateNodes;
 }
 
-void QgsGeometryFixes::apply( QgsGeometry &geometry ) const
+void QgsGeometryOptions::apply( QgsGeometry &geometry ) const
 {
   if ( mGeometryPrecision != 0.0 )
     geometry = geometry.snappedToGrid( mGeometryPrecision, mGeometryPrecision );
 
   if ( mRemoveDuplicateNodes )
     geometry.removeDuplicateNodes();
 }
+
+void QgsGeometryOptions::writeXml( QDomNode &node ) const
+{
+  QDomElement geometryOptionsElement = node.ownerDocument().createElement( QStringLiteral( "geometryOptions" ) );
+  node.appendChild( geometryOptionsElement );
+
+  geometryOptionsElement.setAttribute( QStringLiteral( "removeDuplicateNodes" ), mRemoveDuplicateNodes ? 1 : 0 );
+  geometryOptionsElement.setAttribute( QStringLiteral( "geometryPrecision" ), mGeometryPrecision );
+}
+
+void QgsGeometryOptions::readXml( const QDomNode &node )
+{
+  QDomElement geometryOptionsElement = node.toElement();
+  setGeometryPrecision( geometryOptionsElement.attribute( QStringLiteral( "geometryPrecision" ),  QStringLiteral( "0.0" ) ).toDouble() );
+  setRemoveDuplicateNodes( geometryOptionsElement.attribute( QStringLiteral( "removeDuplicateNodes" ),  QStringLiteral( "0" ) ).toInt() == 1 );
+}

src/core/qgsgeometryfixes.h src/core/qgsgeometryoptions.h

@@ -1,5 +1,5 @@
 /***************************************************************************
-                          qgsgeometryfixes.h
+                          qgsgeometryoptions.h
                              -------------------
     begin                : Aug 23, 2018
     copyright            : (C) 2018 by Matthias Kuhn
@@ -15,27 +15,29 @@
  *                                                                         *
  ***************************************************************************/
 
-#ifndef QGSGEOMETRYFIXES_H
-#define QGSGEOMETRYFIXES_H
+#ifndef QGSGEOMETRYOPTIONS_H
+#define QGSGEOMETRYOPTIONS_H
 
+#include "qgis_core.h"
+#include "qgis_sip.h"
 #include "qgsgeometry.h"
 
 /**
  * \ingroup core
  *
- * The QgsGeometryFixes class contains options to automatically adjust geometries to
+ * The QgsGeometryOptions class contains options to automatically adjust geometries to
  * constraints on a layer.
  *
  * \since QGIS 3.4
  */
-class CORE_EXPORT QgsGeometryFixes
+class CORE_EXPORT QgsGeometryOptions
 {
   public:
 
     /**
-     * Create a new QgsGeometryFixes object.
+     * Create a new QgsGeometryOptions object.
      */
-    QgsGeometryFixes() = default;
+    QgsGeometryOptions() = default;
 
     /**
      * Automatically remove duplicate nodes on all geometries which are edited on this layer.
@@ -83,6 +85,20 @@ class CORE_EXPORT QgsGeometryFixes
      */
     void apply( QgsGeometry &geometry ) const;
 
+    /**
+     * Write the geometry options to the \a node.
+     *
+     * \since QGIS 3.4
+     */
+    void writeXml( QDomNode &node ) const;
+
+    /**
+     * Read the geometry options from \a node.
+     *
+     * \since QGIS 3.4
+     */
+    void readXml( const QDomNode &node );
+
   private:
 
     /**
@@ -102,4 +118,4 @@ class CORE_EXPORT QgsGeometryFixes
     double mGeometryPrecision = 0.0;
 };
 
-#endif // QGSGEOMETRYFIXES_H
+#endif // QGSGEOMETRYOPTIONS_H

src/core/qgsmaplayer.h

@@ -153,8 +153,9 @@ class CORE_EXPORT QgsMapLayer : public QObject
       AttributeTable     = 1 << 9,  //!< Attribute table settings: choice and order of columns, conditional styling
       Rendering          = 1 << 10, //!< Rendering: scale visibility, simplify method, opacity
       CustomProperties   = 1 << 11, //!< Custom properties (by plugins for instance)
+      GeometryOptions    = 1 << 12, //!< Geometry validation configuration
       AllStyleCategories = LayerConfiguration | Symbology | Symbology3D | Labeling | Fields | Forms | Actions |
-                           MapTips | Diagrams | AttributeTable | Rendering | CustomProperties,
+                           MapTips | Diagrams | AttributeTable | Rendering | CustomProperties | GeometryOptions,
     };
     Q_ENUM( StyleCategory )
     Q_DECLARE_FLAGS( StyleCategories, StyleCategory )