Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmextentfromlayer.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : November 2019
       5                 :            :     copyright            : (C) 2019 by Alexander Bruy
       6                 :            :     email                : alexander dot bruy 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 "qgsalgorithmextentfromlayer.h"
      19                 :            : #include "qgsapplication.h"
      20                 :            : #include "qgsvectorlayer.h"
      21                 :            : 
      22                 :            : ///@cond PRIVATE
      23                 :            : 
      24                 :          0 : QString QgsExtentFromLayerAlgorithm::name() const
      25                 :            : {
      26                 :          0 :   return QStringLiteral( "polygonfromlayerextent" );
      27                 :            : }
      28                 :            : 
      29                 :          0 : QString QgsExtentFromLayerAlgorithm::displayName() const
      30                 :            : {
      31                 :          0 :   return QObject::tr( "Extract layer extent" );
      32                 :            : }
      33                 :            : 
      34                 :          0 : QStringList QgsExtentFromLayerAlgorithm::tags() const
      35                 :            : {
      36                 :          0 :   return QObject::tr( "polygon,vector,raster,extent,envelope,bounds,bounding,boundary,layer,round,rounded" ).split( ',' );
      37                 :          0 : }
      38                 :            : 
      39                 :          0 : QString QgsExtentFromLayerAlgorithm::group() const
      40                 :            : {
      41                 :          0 :   return QObject::tr( "Layer tools" );
      42                 :            : }
      43                 :            : 
      44                 :          0 : QString QgsExtentFromLayerAlgorithm::groupId() const
      45                 :            : {
      46                 :          0 :   return QStringLiteral( "layertools" );
      47                 :            : }
      48                 :            : 
      49                 :          0 : QString QgsExtentFromLayerAlgorithm::shortHelpString() const
      50                 :            : {
      51                 :          0 :   return QObject::tr( "This algorithm takes a map layer and generates a new vector "
      52                 :            :                       "layer with the minimum bounding box (rectangle polygon with "
      53                 :            :                       "N-S orientation) that covers the input layer. Optionally, the "
      54                 :            :                       "extent can be enlarged to a rounded value." );
      55                 :            : }
      56                 :            : 
      57                 :          0 : QString QgsExtentFromLayerAlgorithm::svgIconPath() const
      58                 :            : {
      59                 :          0 :   return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmExtractLayerExtent.svg" ) );
      60                 :          0 : }
      61                 :            : 
      62                 :          0 : QIcon QgsExtentFromLayerAlgorithm::icon() const
      63                 :            : {
      64                 :          0 :   return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmExtractLayerExtent.svg" ) );
      65                 :          0 : }
      66                 :            : 
      67                 :          0 : QgsExtentFromLayerAlgorithm *QgsExtentFromLayerAlgorithm::createInstance() const
      68                 :            : {
      69                 :          0 :   return new QgsExtentFromLayerAlgorithm();
      70                 :            : }
      71                 :            : 
      72                 :          0 : void QgsExtentFromLayerAlgorithm::initAlgorithm( const QVariantMap & )
      73                 :            : {
      74                 :          0 :   addParameter( new QgsProcessingParameterMapLayer( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
      75                 :            : 
      76                 :          0 :   auto roundParam = std::make_unique < QgsProcessingParameterDistance >( QStringLiteral( "ROUND_TO" ), QObject::tr( "Round values to" ), 0, QStringLiteral( "INPUT" ), 0 );
      77                 :          0 :   roundParam->setFlags( QgsProcessingParameterDefinition::FlagAdvanced );
      78                 :          0 :   addParameter( roundParam.release() );
      79                 :            : 
      80                 :          0 :   addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Extent" ), QgsProcessing::TypeVectorPolygon ) );
      81                 :          0 : }
      82                 :            : 
      83                 :          0 : QVariantMap QgsExtentFromLayerAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      84                 :            : {
      85                 :          0 :   QgsMapLayer *layer = parameterAsLayer( parameters, QStringLiteral( "INPUT" ), context );
      86                 :            : 
      87                 :          0 :   if ( !layer )
      88                 :          0 :     throw QgsProcessingException( QObject::tr( "Invalid input layer" ) );
      89                 :            : 
      90                 :          0 :   double roundTo = parameterAsDouble( parameters, QStringLiteral( "ROUND_TO" ), context );
      91                 :            : 
      92                 :          0 :   QgsFields fields;
      93                 :          0 :   fields.append( QgsField( QStringLiteral( "MINX" ), QVariant::Double ) );
      94                 :          0 :   fields.append( QgsField( QStringLiteral( "MINY" ), QVariant::Double ) );
      95                 :          0 :   fields.append( QgsField( QStringLiteral( "MAXX" ), QVariant::Double ) );
      96                 :          0 :   fields.append( QgsField( QStringLiteral( "MAXY" ), QVariant::Double ) );
      97                 :          0 :   fields.append( QgsField( QStringLiteral( "CNTX" ), QVariant::Double ) );
      98                 :          0 :   fields.append( QgsField( QStringLiteral( "CNTY" ), QVariant::Double ) );
      99                 :          0 :   fields.append( QgsField( QStringLiteral( "AREA" ), QVariant::Double ) );
     100                 :          0 :   fields.append( QgsField( QStringLiteral( "PERIM" ), QVariant::Double ) );
     101                 :          0 :   fields.append( QgsField( QStringLiteral( "HEIGHT" ), QVariant::Double ) );
     102                 :          0 :   fields.append( QgsField( QStringLiteral( "WIDTH" ), QVariant::Double ) );
     103                 :            : 
     104                 :          0 :   QString dest;
     105                 :          0 :   std::unique_ptr< QgsFeatureSink > sink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, dest, fields, QgsWkbTypes::Polygon, layer->crs() ) );
     106                 :          0 :   if ( !sink )
     107                 :          0 :     throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) );
     108                 :            : 
     109                 :          0 :   if ( QgsVectorLayer *vl = qobject_cast< QgsVectorLayer * >( layer ) )
     110                 :            :   {
     111                 :          0 :     vl->updateExtents();
     112                 :          0 :   }
     113                 :            : 
     114                 :          0 :   QgsRectangle rect = layer->extent();
     115                 :            : 
     116                 :          0 :   if ( roundTo > 0 )
     117                 :            :   {
     118                 :          0 :     rect.setXMinimum( std::floor( rect.xMinimum() / roundTo ) * roundTo );
     119                 :          0 :     rect.setYMinimum( std::floor( rect.yMinimum() / roundTo ) * roundTo );
     120                 :          0 :     rect.setXMaximum( std::ceil( rect.xMaximum() / roundTo ) * roundTo );
     121                 :          0 :     rect.setYMaximum( std::ceil( rect.yMaximum() / roundTo ) * roundTo );
     122                 :          0 :   }
     123                 :            : 
     124                 :          0 :   QgsGeometry geom = QgsGeometry::fromRect( rect );
     125                 :            : 
     126                 :          0 :   double minX = rect.xMinimum();
     127                 :          0 :   double maxX = rect.xMaximum();
     128                 :          0 :   double minY = rect.yMinimum();
     129                 :          0 :   double maxY = rect.yMaximum();
     130                 :          0 :   double height = rect.height();
     131                 :          0 :   double width = rect.width();
     132                 :          0 :   double cntX = minX + width / 2.0;
     133                 :          0 :   double cntY = minY + height / 2.0;
     134                 :          0 :   double area = width * height;
     135                 :          0 :   double perim = 2 * width + 2 * height;
     136                 :            : 
     137                 :          0 :   QgsFeature feat;
     138                 :          0 :   feat.setGeometry( geom );
     139                 :          0 :   feat.setAttributes( QgsAttributes() << minX << minY << maxX << maxY << cntX << cntY << area << perim << height << width );
     140                 :          0 :   sink->addFeature( feat, QgsFeatureSink::FastInsert );
     141                 :            : 
     142                 :          0 :   QVariantMap outputs;
     143                 :          0 :   outputs.insert( QStringLiteral( "OUTPUT" ), dest );
     144                 :          0 :   return outputs;
     145                 :          0 : }
     146                 :            : 
     147                 :            : ///@endcond