Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmlinesubstring.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : August 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 "qgsalgorithmlinesubstring.h"
      19                 :            : #include "qgsgeometrycollection.h"
      20                 :            : #include "qgscurve.h"
      21                 :            : 
      22                 :            : ///@cond PRIVATE
      23                 :            : 
      24                 :          0 : QString QgsLineSubstringAlgorithm::name() const
      25                 :            : {
      26                 :          0 :   return QStringLiteral( "linesubstring" );
      27                 :            : }
      28                 :            : 
      29                 :          0 : QString QgsLineSubstringAlgorithm::displayName() const
      30                 :            : {
      31                 :          0 :   return QObject::tr( "Line substring" );
      32                 :            : }
      33                 :            : 
      34                 :          0 : QStringList QgsLineSubstringAlgorithm::tags() const
      35                 :            : {
      36                 :          0 :   return QObject::tr( "linestring,curve,split,shorten,shrink,portion,part,reference,referencing,distance,interpolate" ).split( ',' );
      37                 :          0 : }
      38                 :            : 
      39                 :          0 : QString QgsLineSubstringAlgorithm::group() const
      40                 :            : {
      41                 :          0 :   return QObject::tr( "Vector geometry" );
      42                 :            : }
      43                 :            : 
      44                 :          0 : QString QgsLineSubstringAlgorithm::groupId() const
      45                 :            : {
      46                 :          0 :   return QStringLiteral( "vectorgeometry" );
      47                 :            : }
      48                 :            : 
      49                 :          0 : QString QgsLineSubstringAlgorithm::outputName() const
      50                 :            : {
      51                 :          0 :   return QObject::tr( "Substring" );
      52                 :            : }
      53                 :            : 
      54                 :          0 : QString QgsLineSubstringAlgorithm::shortHelpString() const
      55                 :            : {
      56                 :          0 :   return QObject::tr( "This algorithm returns the portion of a line (or curve) which falls "
      57                 :            :                       "between the specified start and end distances (measured from the "
      58                 :            :                       "beginning of the line).\n\n"
      59                 :            :                       "Z and M values are linearly interpolated from existing values.\n\n"
      60                 :            :                       "If a multipart geometry is encountered, only the first part is considered when "
      61                 :            :                       "calculating the substring." );
      62                 :            : }
      63                 :            : 
      64                 :          0 : QString QgsLineSubstringAlgorithm::shortDescription() const
      65                 :            : {
      66                 :          0 :   return QObject::tr( "Returns the substring of lines which fall between start and end distances." );
      67                 :            : }
      68                 :            : 
      69                 :          0 : QList<int> QgsLineSubstringAlgorithm::inputLayerTypes() const
      70                 :            : {
      71                 :          0 :   return QList<int>() << QgsProcessing::TypeVectorLine;
      72                 :          0 : }
      73                 :            : 
      74                 :          0 : QgsProcessing::SourceType QgsLineSubstringAlgorithm::outputLayerType() const
      75                 :            : {
      76                 :          0 :   return QgsProcessing::TypeVectorLine;
      77                 :            : }
      78                 :            : 
      79                 :          0 : QgsLineSubstringAlgorithm *QgsLineSubstringAlgorithm::createInstance() const
      80                 :            : {
      81                 :          0 :   return new QgsLineSubstringAlgorithm();
      82                 :          0 : }
      83                 :            : 
      84                 :          0 : void QgsLineSubstringAlgorithm::initParameters( const QVariantMap & )
      85                 :            : {
      86                 :          0 :   std::unique_ptr< QgsProcessingParameterDistance> startDistance = std::make_unique< QgsProcessingParameterDistance >( QStringLiteral( "START_DISTANCE" ),
      87                 :          0 :       QObject::tr( "Start distance" ), 0.0, QStringLiteral( "INPUT" ), false, 0 );
      88                 :          0 :   startDistance->setIsDynamic( true );
      89                 :          0 :   startDistance->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "Start Distance" ), QObject::tr( "Start distance" ), QgsPropertyDefinition::DoublePositive ) );
      90                 :          0 :   startDistance->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
      91                 :          0 :   addParameter( startDistance.release() );
      92                 :            : 
      93                 :          0 :   std::unique_ptr< QgsProcessingParameterDistance> endDistance = std::make_unique< QgsProcessingParameterDistance >( QStringLiteral( "END_DISTANCE" ),
      94                 :          0 :       QObject::tr( "End distance" ), 1.0, QStringLiteral( "INPUT" ), false, 0 );
      95                 :          0 :   endDistance->setIsDynamic( true );
      96                 :          0 :   endDistance->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "End Distance" ), QObject::tr( "End distance" ), QgsPropertyDefinition::DoublePositive ) );
      97                 :          0 :   endDistance->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
      98                 :          0 :   addParameter( endDistance.release() );
      99                 :          0 : }
     100                 :            : 
     101                 :          0 : QgsProcessingFeatureSource::Flag QgsLineSubstringAlgorithm::sourceFlags() const
     102                 :            : {
     103                 :            :   // skip geometry checks - this algorithm doesn't care about invalid geometries
     104                 :          0 :   return QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks;
     105                 :            : }
     106                 :            : 
     107                 :          0 : bool QgsLineSubstringAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
     108                 :            : {
     109                 :          0 :   mStartDistance = parameterAsDouble( parameters, QStringLiteral( "START_DISTANCE" ), context );
     110                 :          0 :   mDynamicStartDistance = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "START_DISTANCE" ) );
     111                 :          0 :   if ( mDynamicStartDistance )
     112                 :          0 :     mStartDistanceProperty = parameters.value( QStringLiteral( "START_DISTANCE" ) ).value< QgsProperty >();
     113                 :            : 
     114                 :          0 :   mEndDistance = parameterAsDouble( parameters, QStringLiteral( "END_DISTANCE" ), context );
     115                 :          0 :   mDynamicEndDistance = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "END_DISTANCE" ) );
     116                 :          0 :   if ( mDynamicEndDistance )
     117                 :          0 :     mEndDistanceProperty = parameters.value( QStringLiteral( "END_DISTANCE" ) ).value< QgsProperty >();
     118                 :            : 
     119                 :          0 :   return true;
     120                 :          0 : }
     121                 :            : 
     122                 :          0 : QgsFeatureList QgsLineSubstringAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback * )
     123                 :            : {
     124                 :          0 :   QgsFeature f = feature;
     125                 :          0 :   if ( f.hasGeometry() )
     126                 :            :   {
     127                 :          0 :     const QgsGeometry geometry = f.geometry();
     128                 :          0 :     double startDistance = mStartDistance;
     129                 :          0 :     if ( mDynamicStartDistance )
     130                 :          0 :       startDistance = mStartDistanceProperty.valueAsDouble( context.expressionContext(), startDistance );
     131                 :            : 
     132                 :          0 :     double endDistance = mEndDistance;
     133                 :          0 :     if ( mDynamicEndDistance )
     134                 :          0 :       endDistance = mEndDistanceProperty.valueAsDouble( context.expressionContext(), endDistance );
     135                 :            : 
     136                 :          0 :     const QgsCurve *curve = nullptr;
     137                 :          0 :     if ( !geometry.isMultipart() )
     138                 :          0 :       curve = qgsgeometry_cast< const QgsCurve * >( geometry.constGet() );
     139                 :            :     else
     140                 :            :     {
     141                 :          0 :       if ( const QgsGeometryCollection *collection = qgsgeometry_cast< const QgsGeometryCollection * >( geometry.constGet() ) )
     142                 :            :       {
     143                 :          0 :         if ( collection->numGeometries() > 0 )
     144                 :            :         {
     145                 :          0 :           curve = qgsgeometry_cast< const QgsCurve * >( collection->geometryN( 0 ) );
     146                 :          0 :         }
     147                 :          0 :       }
     148                 :            :     }
     149                 :          0 :     if ( curve )
     150                 :            :     {
     151                 :          0 :       std::unique_ptr< QgsCurve > substring( curve->curveSubstring( startDistance, endDistance ) );
     152                 :          0 :       QgsGeometry result( std::move( substring ) );
     153                 :          0 :       f.setGeometry( result );
     154                 :          0 :     }
     155                 :            :     else
     156                 :            :     {
     157                 :          0 :       f.clearGeometry();
     158                 :            :     }
     159                 :          0 :   }
     160                 :          0 :   return QgsFeatureList() << f;
     161                 :          0 : }
     162                 :            : 
     163                 :            : ///@endcond
     164                 :            : 
     165                 :            :