Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmsetzvalue.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 "qgsalgorithmsetzvalue.h"
      19                 :            : #include "qgsvectorlayer.h"
      20                 :            : 
      21                 :            : ///@cond PRIVATE
      22                 :            : 
      23                 :          0 : QString QgsSetZValueAlgorithm::name() const
      24                 :            : {
      25                 :          0 :   return QStringLiteral( "setzvalue" );
      26                 :            : }
      27                 :            : 
      28                 :          0 : QString QgsSetZValueAlgorithm::displayName() const
      29                 :            : {
      30                 :          0 :   return QObject::tr( "Set Z value" );
      31                 :            : }
      32                 :            : 
      33                 :          0 : QStringList QgsSetZValueAlgorithm::tags() const
      34                 :            : {
      35                 :          0 :   return QObject::tr( "set,add,z,25d,3d,values" ).split( ',' );
      36                 :          0 : }
      37                 :            : 
      38                 :          0 : QString QgsSetZValueAlgorithm::group() const
      39                 :            : {
      40                 :          0 :   return QObject::tr( "Vector geometry" );
      41                 :            : }
      42                 :            : 
      43                 :          0 : QString QgsSetZValueAlgorithm::groupId() const
      44                 :            : {
      45                 :          0 :   return QStringLiteral( "vectorgeometry" );
      46                 :            : }
      47                 :            : 
      48                 :          0 : QString QgsSetZValueAlgorithm::shortHelpString() const
      49                 :            : {
      50                 :          0 :   return QObject::tr( "This algorithm sets the Z value for geometries in a layer.\n\n"
      51                 :            :                       "If Z values already exist in the layer, they will be overwritten "
      52                 :            :                       "with the new value. If no Z values exist, the geometry will be "
      53                 :            :                       "upgraded to include Z values and the specified value used as "
      54                 :            :                       "the initial Z value for all geometries." );
      55                 :            : }
      56                 :            : 
      57                 :          0 : QString QgsSetZValueAlgorithm::outputName() const
      58                 :            : {
      59                 :          0 :   return QObject::tr( "Z Added" );
      60                 :            : }
      61                 :            : 
      62                 :          0 : QgsSetZValueAlgorithm *QgsSetZValueAlgorithm::createInstance() const
      63                 :            : {
      64                 :          0 :   return new QgsSetZValueAlgorithm();
      65                 :          0 : }
      66                 :            : 
      67                 :          0 : bool QgsSetZValueAlgorithm::supportInPlaceEdit( const QgsMapLayer *l ) const
      68                 :            : {
      69                 :          0 :   const QgsVectorLayer *layer = qobject_cast< const QgsVectorLayer * >( l );
      70                 :          0 :   if ( !layer )
      71                 :          0 :     return false;
      72                 :            : 
      73                 :          0 :   return QgsProcessingFeatureBasedAlgorithm::supportInPlaceEdit( l ) && QgsWkbTypes::hasZ( layer->wkbType() );
      74                 :          0 : }
      75                 :            : 
      76                 :          0 : QgsProcessingFeatureSource::Flag QgsSetZValueAlgorithm::sourceFlags() const
      77                 :            : {
      78                 :          0 :   return QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks;
      79                 :            : }
      80                 :            : 
      81                 :          0 : QgsWkbTypes::Type QgsSetZValueAlgorithm::outputWkbType( QgsWkbTypes::Type type ) const
      82                 :            : {
      83                 :          0 :   return QgsWkbTypes::addZ( type );
      84                 :            : }
      85                 :            : 
      86                 :          0 : void QgsSetZValueAlgorithm::initParameters( const QVariantMap & )
      87                 :            : {
      88                 :          0 :   auto zValueParam = std::make_unique < QgsProcessingParameterNumber >( QStringLiteral( "Z_VALUE" ), QObject::tr( "Z Value" ), QgsProcessingParameterNumber::Double, 0.0 );
      89                 :          0 :   zValueParam->setIsDynamic( true );
      90                 :          0 :   zValueParam->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "Z_VALUE" ), QObject::tr( "Z Value" ), QgsPropertyDefinition::Double ) );
      91                 :          0 :   zValueParam->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
      92                 :          0 :   addParameter( zValueParam.release() );
      93                 :          0 : }
      94                 :            : 
      95                 :          0 : bool QgsSetZValueAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      96                 :            : {
      97                 :          0 :   mZValue = parameterAsDouble( parameters, QStringLiteral( "Z_VALUE" ), context );
      98                 :          0 :   mDynamicZValue = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "Z_VALUE" ) );
      99                 :          0 :   if ( mDynamicZValue )
     100                 :          0 :     mZValueProperty = parameters.value( QStringLiteral( "Z_VALUE" ) ).value< QgsProperty >();
     101                 :            : 
     102                 :          0 :   return true;
     103                 :          0 : }
     104                 :            : 
     105                 :          0 : QgsFeatureList QgsSetZValueAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback * )
     106                 :            : {
     107                 :          0 :   QgsFeature f = feature;
     108                 :            : 
     109                 :          0 :   if ( f.hasGeometry() )
     110                 :            :   {
     111                 :          0 :     std::unique_ptr< QgsAbstractGeometry > newGeometry( f.geometry().constGet()->clone() );
     112                 :            :     // addZValue won't alter existing Z values, so drop them first
     113                 :          0 :     if ( QgsWkbTypes::hasZ( newGeometry->wkbType() ) )
     114                 :          0 :       newGeometry->dropZValue();
     115                 :            : 
     116                 :          0 :     double z = mZValue;
     117                 :          0 :     if ( mDynamicZValue )
     118                 :          0 :       z = mZValueProperty.valueAsDouble( context.expressionContext(), z );
     119                 :            : 
     120                 :          0 :     newGeometry->addZValue( z );
     121                 :            : 
     122                 :          0 :     f.setGeometry( QgsGeometry( std::move( newGeometry ) ) );
     123                 :          0 :   }
     124                 :            : 
     125                 :          0 :   return QgsFeatureList() << f;
     126                 :          0 : }
     127                 :            : 
     128                 :            : ///@endcond