Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithminterpolatepoint.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 "qgsalgorithminterpolatepoint.h"
      19                 :            : #include "qgsgeometrycollection.h"
      20                 :            : #include "qgscurve.h"
      21                 :            : 
      22                 :            : ///@cond PRIVATE
      23                 :            : 
      24                 :          0 : QString QgsInterpolatePointAlgorithm::name() const
      25                 :            : {
      26                 :          0 :   return QStringLiteral( "interpolatepoint" );
      27                 :            : }
      28                 :            : 
      29                 :          0 : QString QgsInterpolatePointAlgorithm::displayName() const
      30                 :            : {
      31                 :          0 :   return QObject::tr( "Interpolate point on line" );
      32                 :            : }
      33                 :            : 
      34                 :          0 : QStringList QgsInterpolatePointAlgorithm::tags() const
      35                 :            : {
      36                 :          0 :   return QObject::tr( "linestring,reference,referencing,distance,interpolate" ).split( ',' );
      37                 :          0 : }
      38                 :            : 
      39                 :          0 : QString QgsInterpolatePointAlgorithm::group() const
      40                 :            : {
      41                 :          0 :   return QObject::tr( "Vector geometry" );
      42                 :            : }
      43                 :            : 
      44                 :          0 : QString QgsInterpolatePointAlgorithm::groupId() const
      45                 :            : {
      46                 :          0 :   return QStringLiteral( "vectorgeometry" );
      47                 :            : }
      48                 :            : 
      49                 :          0 : QString QgsInterpolatePointAlgorithm::outputName() const
      50                 :            : {
      51                 :          0 :   return QObject::tr( "Interpolated points" );
      52                 :            : }
      53                 :            : 
      54                 :          0 : QString QgsInterpolatePointAlgorithm::shortHelpString() const
      55                 :            : {
      56                 :          0 :   return QObject::tr( "This algorithm creates a point geometry interpolated at a set distance along line or curve geometries.\n\n"
      57                 :            :                       "Z and M values are linearly interpolated from existing values.\n\n"
      58                 :            :                       "If a multipart geometry is encountered, only the first part is considered when "
      59                 :            :                       "interpolating the point.\n\n"
      60                 :            :                       "If the specified distance is greater than the curve's length, the resultant feature will have a null geometry." );
      61                 :            : }
      62                 :            : 
      63                 :          0 : QString QgsInterpolatePointAlgorithm::shortDescription() const
      64                 :            : {
      65                 :          0 :   return QObject::tr( "Interpolates a point along lines at a set distance." );
      66                 :            : }
      67                 :            : 
      68                 :          0 : QList<int> QgsInterpolatePointAlgorithm::inputLayerTypes() const
      69                 :            : {
      70                 :          0 :   return QList<int>() << QgsProcessing::TypeVectorLine << QgsProcessing::TypeVectorPolygon;
      71                 :          0 : }
      72                 :            : 
      73                 :          0 : QgsProcessing::SourceType QgsInterpolatePointAlgorithm::outputLayerType() const
      74                 :            : {
      75                 :          0 :   return QgsProcessing::TypeVectorPoint;
      76                 :            : }
      77                 :            : 
      78                 :          0 : QgsWkbTypes::Type QgsInterpolatePointAlgorithm::outputWkbType( QgsWkbTypes::Type inputType ) const
      79                 :            : {
      80                 :          0 :   QgsWkbTypes::Type out = QgsWkbTypes::Point;
      81                 :          0 :   if ( QgsWkbTypes::hasZ( inputType ) )
      82                 :          0 :     out = QgsWkbTypes::addZ( out );
      83                 :          0 :   if ( QgsWkbTypes::hasM( inputType ) )
      84                 :          0 :     out = QgsWkbTypes::addM( out );
      85                 :          0 :   return out;
      86                 :            : }
      87                 :            : 
      88                 :          0 : QgsInterpolatePointAlgorithm *QgsInterpolatePointAlgorithm::createInstance() const
      89                 :            : {
      90                 :          0 :   return new QgsInterpolatePointAlgorithm();
      91                 :          0 : }
      92                 :            : 
      93                 :          0 : void QgsInterpolatePointAlgorithm::initParameters( const QVariantMap & )
      94                 :            : {
      95                 :          0 :   std::unique_ptr< QgsProcessingParameterDistance> distance = std::make_unique< QgsProcessingParameterDistance >( QStringLiteral( "DISTANCE" ),
      96                 :          0 :       QObject::tr( "Distance" ), 0.0, QStringLiteral( "INPUT" ), false, 0 );
      97                 :          0 :   distance->setIsDynamic( true );
      98                 :          0 :   distance->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "DISTANCE" ), QObject::tr( "Distance" ), QgsPropertyDefinition::DoublePositive ) );
      99                 :          0 :   distance->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
     100                 :          0 :   addParameter( distance.release() );
     101                 :          0 : }
     102                 :            : 
     103                 :          0 : QgsProcessingFeatureSource::Flag QgsInterpolatePointAlgorithm::sourceFlags() const
     104                 :            : {
     105                 :            :   // skip geometry checks - this algorithm doesn't care about invalid geometries
     106                 :          0 :   return QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks;
     107                 :            : }
     108                 :            : 
     109                 :          0 : bool QgsInterpolatePointAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
     110                 :            : {
     111                 :          0 :   mDistance = parameterAsDouble( parameters, QStringLiteral( "DISTANCE" ), context );
     112                 :          0 :   mDynamicDistance = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "DISTANCE" ) );
     113                 :          0 :   if ( mDynamicDistance )
     114                 :          0 :     mDistanceProperty = parameters.value( QStringLiteral( "DISTANCE" ) ).value< QgsProperty >();
     115                 :            : 
     116                 :          0 :   return true;
     117                 :          0 : }
     118                 :            : 
     119                 :          0 : QgsFeatureList QgsInterpolatePointAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback * )
     120                 :            : {
     121                 :          0 :   QgsFeature f = feature;
     122                 :          0 :   if ( f.hasGeometry() )
     123                 :            :   {
     124                 :          0 :     const QgsGeometry geometry = f.geometry();
     125                 :          0 :     double distance = mDistance;
     126                 :          0 :     if ( mDynamicDistance )
     127                 :          0 :       distance = mDistanceProperty.valueAsDouble( context.expressionContext(), distance );
     128                 :            : 
     129                 :          0 :     f.setGeometry( geometry.interpolate( distance ) );
     130                 :          0 :   }
     131                 :          0 :   return QgsFeatureList() << f;
     132                 :          0 : }
     133                 :            : 
     134                 :            : ///@endcond
     135                 :            : 
     136                 :            :