Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmremoveholes.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : March 2018
       5                 :            :     copyright            : (C) 2018 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #include "qgsalgorithmremoveholes.h"
      19                 :            : 
      20                 :            : ///@cond PRIVATE
      21                 :            : 
      22                 :          0 : QString QgsRemoveHolesAlgorithm::name() const
      23                 :            : {
      24                 :          0 :   return QStringLiteral( "deleteholes" );
      25                 :            : }
      26                 :            : 
      27                 :          0 : QString QgsRemoveHolesAlgorithm::displayName() const
      28                 :            : {
      29                 :          0 :   return QObject::tr( "Delete holes" );
      30                 :            : }
      31                 :            : 
      32                 :          0 : QStringList QgsRemoveHolesAlgorithm::tags() const
      33                 :            : {
      34                 :          0 :   return QObject::tr( "remove,delete,drop,holes,rings,fill" ).split( ',' );
      35                 :          0 : }
      36                 :            : 
      37                 :          0 : QString QgsRemoveHolesAlgorithm::group() const
      38                 :            : {
      39                 :          0 :   return QObject::tr( "Vector geometry" );
      40                 :            : }
      41                 :            : 
      42                 :          0 : QString QgsRemoveHolesAlgorithm::groupId() const
      43                 :            : {
      44                 :          0 :   return QStringLiteral( "vectorgeometry" );
      45                 :            : }
      46                 :            : 
      47                 :          0 : QString QgsRemoveHolesAlgorithm::outputName() const
      48                 :            : {
      49                 :          0 :   return QObject::tr( "Cleaned" );
      50                 :            : }
      51                 :            : 
      52                 :          0 : QList<int> QgsRemoveHolesAlgorithm::inputLayerTypes() const
      53                 :            : {
      54                 :          0 :   return QList<int>() << QgsProcessing::TypeVectorPolygon;
      55                 :          0 : }
      56                 :            : 
      57                 :          0 : QgsProcessing::SourceType QgsRemoveHolesAlgorithm::outputLayerType() const
      58                 :            : {
      59                 :          0 :   return QgsProcessing::TypeVectorPolygon;
      60                 :            : }
      61                 :            : 
      62                 :          0 : QString QgsRemoveHolesAlgorithm::shortHelpString() const
      63                 :            : {
      64                 :          0 :   return QObject::tr( "This algorithm takes a polygon layer and removes holes in polygons. It creates a new vector "
      65                 :            :                       "layer in which polygons with holes have been replaced by polygons with only their external ring. "
      66                 :            :                       "Attributes are not modified.\n\n"
      67                 :            :                       "An optional minimum area parameter allows removing only holes which are smaller than a specified "
      68                 :            :                       "area threshold. Leaving this parameter as 0.0 results in all holes being removed." );
      69                 :            : }
      70                 :            : 
      71                 :          0 : QgsRemoveHolesAlgorithm *QgsRemoveHolesAlgorithm::createInstance() const
      72                 :            : {
      73                 :          0 :   return new QgsRemoveHolesAlgorithm();
      74                 :          0 : }
      75                 :            : 
      76                 :          0 : QgsProcessingFeatureSource::Flag QgsRemoveHolesAlgorithm::sourceFlags() const
      77                 :            : {
      78                 :            :   // skip geometry checks - this algorithm can be used to repair geometries
      79                 :          0 :   return QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks;
      80                 :            : }
      81                 :            : 
      82                 :          0 : void QgsRemoveHolesAlgorithm::initParameters( const QVariantMap & )
      83                 :            : {
      84                 :          0 :   std::unique_ptr< QgsProcessingParameterNumber > minArea = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "MIN_AREA" ),
      85                 :          0 :       QObject::tr( "Remove holes with area less than" ), QgsProcessingParameterNumber::Double,
      86                 :          0 :       0.0, false, 0 );
      87                 :          0 :   minArea->setIsDynamic( true );
      88                 :          0 :   minArea->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "MIN_AREA" ), QObject::tr( "Remove holes with area less than" ), QgsPropertyDefinition::DoublePositive ) );
      89                 :          0 :   minArea->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
      90                 :          0 :   addParameter( minArea.release() );
      91                 :          0 : }
      92                 :            : 
      93                 :          0 : bool QgsRemoveHolesAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      94                 :            : {
      95                 :          0 :   mMinArea = parameterAsDouble( parameters, QStringLiteral( "MIN_AREA" ), context );
      96                 :          0 :   mDynamicMinArea = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "MIN_AREA" ) );
      97                 :          0 :   if ( mDynamicMinArea )
      98                 :          0 :     mMinAreaProperty = parameters.value( QStringLiteral( "MIN_AREA" ) ).value< QgsProperty >();
      99                 :            : 
     100                 :          0 :   return true;
     101                 :          0 : }
     102                 :            : 
     103                 :          0 : QgsFeatureList QgsRemoveHolesAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback * )
     104                 :            : {
     105                 :          0 :   QgsFeature f = feature;
     106                 :          0 :   if ( f.hasGeometry() )
     107                 :            :   {
     108                 :          0 :     QgsGeometry geometry = f.geometry();
     109                 :            : 
     110                 :          0 :     double minArea = mMinArea;
     111                 :          0 :     if ( mDynamicMinArea )
     112                 :          0 :       minArea = mMinAreaProperty.valueAsDouble( context.expressionContext(), minArea );
     113                 :            : 
     114                 :          0 :     f.setGeometry( geometry.removeInteriorRings( minArea > 0 ? minArea : -1 ) );
     115                 :          0 :   }
     116                 :          0 :   return QgsFeatureList() << f;
     117                 :          0 : }
     118                 :            : 
     119                 :            : 
     120                 :            : ///@endcond
     121                 :            : 
     122                 :            :