Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmpointonsurface.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 "qgsalgorithmpointonsurface.h"
      19                 :            : #include "qgsgeometrycollection.h"
      20                 :            : 
      21                 :            : ///@cond PRIVATE
      22                 :            : 
      23                 :          0 : QString QgsPointOnSurfaceAlgorithm::name() const
      24                 :            : {
      25                 :          0 :   return QStringLiteral( "pointonsurface" );
      26                 :            : }
      27                 :            : 
      28                 :          0 : QString QgsPointOnSurfaceAlgorithm::displayName() const
      29                 :            : {
      30                 :          0 :   return QObject::tr( "Point on surface" );
      31                 :            : }
      32                 :            : 
      33                 :          0 : QStringList QgsPointOnSurfaceAlgorithm::tags() const
      34                 :            : {
      35                 :          0 :   return QObject::tr( "centroid,inside,within" ).split( ',' );
      36                 :          0 : }
      37                 :            : 
      38                 :          0 : QString QgsPointOnSurfaceAlgorithm::group() const
      39                 :            : {
      40                 :          0 :   return QObject::tr( "Vector geometry" );
      41                 :            : }
      42                 :            : 
      43                 :          0 : QString QgsPointOnSurfaceAlgorithm::groupId() const
      44                 :            : {
      45                 :          0 :   return QStringLiteral( "vectorgeometry" );
      46                 :            : }
      47                 :            : 
      48                 :          0 : QString QgsPointOnSurfaceAlgorithm::outputName() const
      49                 :            : {
      50                 :          0 :   return QObject::tr( "Point" );
      51                 :            : }
      52                 :            : 
      53                 :          0 : QgsFeatureSink::SinkFlags QgsPointOnSurfaceAlgorithm::sinkFlags() const
      54                 :            : {
      55                 :          0 :   if ( mAllParts )
      56                 :          0 :     return QgsProcessingFeatureBasedAlgorithm::sinkFlags() | QgsFeatureSink::RegeneratePrimaryKey;
      57                 :            :   else
      58                 :          0 :     return QgsProcessingFeatureBasedAlgorithm::sinkFlags();
      59                 :          0 : }
      60                 :            : 
      61                 :          0 : QString QgsPointOnSurfaceAlgorithm::shortHelpString() const
      62                 :            : {
      63                 :          0 :   return QObject::tr( "Returns a point guaranteed to lie on the surface of a geometry." );
      64                 :            : }
      65                 :            : 
      66                 :          0 : QgsPointOnSurfaceAlgorithm *QgsPointOnSurfaceAlgorithm::createInstance() const
      67                 :            : {
      68                 :          0 :   return new QgsPointOnSurfaceAlgorithm();
      69                 :          0 : }
      70                 :            : 
      71                 :          0 : void QgsPointOnSurfaceAlgorithm::initParameters( const QVariantMap & )
      72                 :            : {
      73                 :          0 :   std::unique_ptr< QgsProcessingParameterBoolean> allParts = std::make_unique< QgsProcessingParameterBoolean >(
      74                 :          0 :         QStringLiteral( "ALL_PARTS" ),
      75                 :          0 :         QObject::tr( "Create point on surface for each part" ),
      76                 :          0 :         false );
      77                 :          0 :   allParts->setIsDynamic( true );
      78                 :          0 :   allParts->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "All parts" ), QObject::tr( "Create point on surface for each part" ), QgsPropertyDefinition::Boolean ) );
      79                 :          0 :   allParts->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
      80                 :          0 :   addParameter( allParts.release() );
      81                 :          0 : }
      82                 :            : 
      83                 :          0 : bool QgsPointOnSurfaceAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      84                 :            : {
      85                 :          0 :   mAllParts = parameterAsBoolean( parameters, QStringLiteral( "ALL_PARTS" ), context );
      86                 :          0 :   mDynamicAllParts = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "ALL_PARTS" ) );
      87                 :          0 :   if ( mDynamicAllParts )
      88                 :          0 :     mAllPartsProperty = parameters.value( QStringLiteral( "ALL_PARTS" ) ).value< QgsProperty >();
      89                 :            : 
      90                 :          0 :   return true;
      91                 :          0 : }
      92                 :            : 
      93                 :          0 : QgsFeatureList QgsPointOnSurfaceAlgorithm::processFeature( const QgsFeature &f, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      94                 :            : {
      95                 :          0 :   QgsFeatureList list;
      96                 :          0 :   QgsFeature feature = f;
      97                 :          0 :   if ( feature.hasGeometry() && !feature.geometry().isEmpty() )
      98                 :            :   {
      99                 :          0 :     QgsGeometry geom = feature.geometry();
     100                 :            : 
     101                 :          0 :     bool allParts = mAllParts;
     102                 :          0 :     if ( mDynamicAllParts )
     103                 :          0 :       allParts = mAllPartsProperty.valueAsBool( context.expressionContext(), allParts );
     104                 :            : 
     105                 :          0 :     if ( allParts && geom.isMultipart() )
     106                 :            :     {
     107                 :          0 :       const QgsGeometryCollection *geomCollection = static_cast<const QgsGeometryCollection *>( geom.constGet() );
     108                 :            : 
     109                 :          0 :       const int partCount = geomCollection->partCount();
     110                 :          0 :       list.reserve( partCount );
     111                 :          0 :       for ( int i = 0; i < partCount; ++i )
     112                 :            :       {
     113                 :          0 :         QgsGeometry partGeometry( geomCollection->geometryN( i )->clone() );
     114                 :          0 :         QgsGeometry outputGeometry = partGeometry.pointOnSurface();
     115                 :          0 :         if ( outputGeometry.isNull() )
     116                 :            :         {
     117                 :          0 :           feedback->reportError( QObject::tr( "Error calculating point on surface for feature %1 part %2: %3" ).arg( feature.id() ).arg( i ).arg( outputGeometry.lastError() ) );
     118                 :          0 :         }
     119                 :          0 :         feature.setGeometry( outputGeometry );
     120                 :          0 :         list << feature;
     121                 :          0 :       }
     122                 :          0 :     }
     123                 :            :     else
     124                 :            :     {
     125                 :          0 :       QgsGeometry outputGeometry = feature.geometry().pointOnSurface();
     126                 :          0 :       if ( outputGeometry.isNull() )
     127                 :            :       {
     128                 :          0 :         feedback->reportError( QObject::tr( "Error calculating point on surface for feature %1: %2" ).arg( feature.id() ).arg( outputGeometry.lastError() ) );
     129                 :          0 :       }
     130                 :          0 :       feature.setGeometry( outputGeometry );
     131                 :          0 :       list << feature;
     132                 :          0 :     }
     133                 :          0 :   }
     134                 :            :   else
     135                 :            :   {
     136                 :          0 :     list << feature;
     137                 :            :   }
     138                 :          0 :   return list;
     139                 :          0 : }
     140                 :            : 
     141                 :            : ///@endcond