Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmoffsetlines.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : July 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 "qgsalgorithmoffsetlines.h"
      19                 :            : 
      20                 :            : ///@cond PRIVATE
      21                 :            : 
      22                 :          0 : QString QgsOffsetLinesAlgorithm::name() const
      23                 :            : {
      24                 :          0 :   return QStringLiteral( "offsetline" );
      25                 :            : }
      26                 :            : 
      27                 :          0 : QString QgsOffsetLinesAlgorithm::displayName() const
      28                 :            : {
      29                 :          0 :   return QObject::tr( "Offset lines" );
      30                 :            : }
      31                 :            : 
      32                 :          0 : QStringList QgsOffsetLinesAlgorithm::tags() const
      33                 :            : {
      34                 :          0 :   return QObject::tr( "offset,linestring" ).split( ',' );
      35                 :          0 : }
      36                 :            : 
      37                 :          0 : QString QgsOffsetLinesAlgorithm::group() const
      38                 :            : {
      39                 :          0 :   return QObject::tr( "Vector geometry" );
      40                 :            : }
      41                 :            : 
      42                 :          0 : QString QgsOffsetLinesAlgorithm::groupId() const
      43                 :            : {
      44                 :          0 :   return QStringLiteral( "vectorgeometry" );
      45                 :            : }
      46                 :            : 
      47                 :          0 : QString QgsOffsetLinesAlgorithm::outputName() const
      48                 :            : {
      49                 :          0 :   return QObject::tr( "Offset" );
      50                 :            : }
      51                 :            : 
      52                 :          0 : QString QgsOffsetLinesAlgorithm::shortHelpString() const
      53                 :            : {
      54                 :          0 :   return QObject::tr( "This algorithm offsets lines by a specified distance. Positive distances will offset lines to the left, and negative distances "
      55                 :            :                       "will offset to the right of lines.\n\n"
      56                 :            :                       "The segments parameter controls the number of line segments to use to approximate a quarter circle when creating rounded offsets.\n\n"
      57                 :            :                       "The join style parameter specifies whether round, miter or beveled joins should be used when offsetting corners in a line.\n\n"
      58                 :            :                       "The miter limit parameter is only applicable for miter join styles, and controls the maximum distance from the offset curve to "
      59                 :            :                       "use when creating a mitered join." );
      60                 :            : }
      61                 :            : 
      62                 :          0 : QString QgsOffsetLinesAlgorithm::shortDescription() const
      63                 :            : {
      64                 :          0 :   return QObject::tr( "Offsets lines by a specified distance." );
      65                 :            : }
      66                 :            : 
      67                 :          0 : QgsOffsetLinesAlgorithm *QgsOffsetLinesAlgorithm::createInstance() const
      68                 :            : {
      69                 :          0 :   return new QgsOffsetLinesAlgorithm();
      70                 :          0 : }
      71                 :            : 
      72                 :          0 : void QgsOffsetLinesAlgorithm::initParameters( const QVariantMap & )
      73                 :            : {
      74                 :          0 :   std::unique_ptr< QgsProcessingParameterDistance > offset = std::make_unique< QgsProcessingParameterDistance >( QStringLiteral( "DISTANCE" ),
      75                 :          0 :       QObject::tr( "Distance" ),
      76                 :          0 :       10.0, QStringLiteral( "INPUT" ) );
      77                 :          0 :   offset->setIsDynamic( true );
      78                 :          0 :   offset->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "DISTANCE" ), QObject::tr( "Distance" ), QgsPropertyDefinition::Double ) );
      79                 :          0 :   offset->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
      80                 :          0 :   addParameter( offset.release() );
      81                 :            : 
      82                 :          0 :   auto segmentParam = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "SEGMENTS" ), QObject::tr( "Segments" ), QgsProcessingParameterNumber::Integer, 8, false, 1 );
      83                 :          0 :   addParameter( segmentParam.release() );
      84                 :            : 
      85                 :          0 :   auto joinStyleParam = std::make_unique< QgsProcessingParameterEnum>( QStringLiteral( "JOIN_STYLE" ), QObject::tr( "Join style" ), QStringList() << QObject::tr( "Round" ) << QObject::tr( "Miter" ) << QObject::tr( "Bevel" ), false, 0 );
      86                 :          0 :   addParameter( joinStyleParam.release() );
      87                 :            : 
      88                 :          0 :   auto miterLimitParam = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "MITER_LIMIT" ), QObject::tr( "Miter limit" ), QgsProcessingParameterNumber::Double, 2, false, 1 );
      89                 :          0 :   addParameter( miterLimitParam.release() );
      90                 :          0 : }
      91                 :            : 
      92                 :          0 : QList<int> QgsOffsetLinesAlgorithm::inputLayerTypes() const
      93                 :            : {
      94                 :          0 :   return QList< int >() << QgsProcessing::TypeVectorLine;
      95                 :          0 : }
      96                 :            : 
      97                 :          0 : QgsProcessing::SourceType QgsOffsetLinesAlgorithm::outputLayerType() const
      98                 :            : {
      99                 :          0 :   return QgsProcessing::TypeVectorLine;
     100                 :            : }
     101                 :            : 
     102                 :          0 : bool QgsOffsetLinesAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
     103                 :            : {
     104                 :          0 :   mOffset = parameterAsDouble( parameters, QStringLiteral( "DISTANCE" ), context );
     105                 :          0 :   mDynamicOffset = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "DISTANCE" ) );
     106                 :          0 :   if ( mDynamicOffset )
     107                 :          0 :     mOffsetProperty = parameters.value( QStringLiteral( "DISTANCE" ) ).value< QgsProperty >();
     108                 :            : 
     109                 :          0 :   mSegments = parameterAsInt( parameters, QStringLiteral( "SEGMENTS" ), context );
     110                 :          0 :   mJoinStyle = static_cast< QgsGeometry::JoinStyle>( 1 + parameterAsInt( parameters, QStringLiteral( "JOIN_STYLE" ), context ) );
     111                 :          0 :   mMiterLimit = parameterAsDouble( parameters, QStringLiteral( "MITER_LIMIT" ), context );
     112                 :            : 
     113                 :          0 :   return true;
     114                 :          0 : }
     115                 :            : 
     116                 :          0 : QgsFeatureList QgsOffsetLinesAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback * )
     117                 :            : {
     118                 :          0 :   if ( feature.hasGeometry() )
     119                 :            :   {
     120                 :          0 :     QgsFeature f = feature;
     121                 :          0 :     const QgsGeometry geometry = feature.geometry();
     122                 :            : 
     123                 :          0 :     double offset = mOffset;
     124                 :          0 :     if ( mDynamicOffset )
     125                 :          0 :       offset = mOffsetProperty.valueAsDouble( context.expressionContext(), offset );
     126                 :            : 
     127                 :          0 :     const QgsGeometry offsetGeometry = geometry.offsetCurve( offset, mSegments, mJoinStyle, mMiterLimit );
     128                 :          0 :     f.setGeometry( offsetGeometry );
     129                 :          0 :     return QgsFeatureList() << f;
     130                 :          0 :   }
     131                 :            :   else
     132                 :            :   {
     133                 :          0 :     return QgsFeatureList() << feature;
     134                 :            :   }
     135                 :          0 : }
     136                 :            : 
     137                 :            : ///@endcond
     138                 :            : 
     139                 :            :