Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmrandompointsonlines.h
       3                 :            :                          ---------------------
       4                 :            :     begin                : March 2020
       5                 :            :     copyright            : (C) 2020 by Håvard Tveite
       6                 :            :     email                : havard dot tveite at nmbu dot no
       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                 :            : 
      19                 :            : #ifndef QGSALGORITHMRANDOMPOINTSONLINES_H
      20                 :            : #define QGSALGORITHMRANDOMPOINTSONLINES_H
      21                 :            : 
      22                 :            : #define SIP_NO_FILE
      23                 :            : 
      24                 :            : #include "qgis_sip.h"
      25                 :            : #include "qgsprocessingalgorithm.h"
      26                 :            : #include "qgsapplication.h"
      27                 :            : 
      28                 :            : ///@cond PRIVATE
      29                 :            : 
      30                 :            : /**
      31                 :            :  * Native random points on lines creation algorithm.
      32                 :            :  */
      33                 :          0 : class QgsRandomPointsOnLinesAlgorithm : public QgsProcessingAlgorithm
      34                 :            : {
      35                 :            :   public:
      36                 :            : 
      37                 :          0 :     QgsRandomPointsOnLinesAlgorithm() = default;
      38                 :            :     void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
      39                 :          0 :     QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmRandomPointsOnLines.svg" ) ); }
      40                 :          0 :     QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmRandomPointsOnLines.svg" ) ); }
      41                 :            :     QString name() const override;
      42                 :            :     QString displayName() const override;
      43                 :            :     QStringList tags() const override;
      44                 :            :     QString group() const override;
      45                 :            :     QString groupId() const override;
      46                 :            :     QString shortHelpString() const override;
      47                 :            :     QgsRandomPointsOnLinesAlgorithm *createInstance() const override SIP_FACTORY;
      48                 :            : 
      49                 :            :   protected:
      50                 :            :     bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
      51                 :            :     QVariantMap processAlgorithm( const QVariantMap &parameters,
      52                 :            :                                   QgsProcessingContext &context,
      53                 :            :                                   QgsProcessingFeedback *feedback ) override;
      54                 :            : 
      55                 :            : 
      56                 :            :   private:
      57                 :            :     int mNumPoints;
      58                 :          0 :     bool mDynamicNumPoints = false;
      59                 :            :     QgsProperty mNumPointsProperty;
      60                 :            : 
      61                 :          0 :     double mMinDistance = 0;
      62                 :          0 :     bool mDynamicMinDistance = false;
      63                 :            :     QgsProperty mMinDistanceProperty;
      64                 :            : 
      65                 :          0 :     double mMinDistanceGlobal = 0;
      66                 :            : 
      67                 :          0 :     int mMaxAttempts = 10;
      68                 :          0 :     bool mDynamicMaxAttempts = false;
      69                 :            :     QgsProperty mMaxAttemptsProperty;
      70                 :            : 
      71                 :          0 :     bool mUseRandomSeed = false;
      72                 :          0 :     int mRandSeed = 0;
      73                 :          0 :     bool mIncludeLineAttr = false;
      74                 :            : };
      75                 :            : 
      76                 :            : ///@endcond PRIVATE
      77                 :            : 
      78                 :            : #endif // QGSALGORITHMRANDOMPOINTSONLINES_H