QGIS API Documentation  3.21.0-Master (56b4176581)
qgsalgorithmrandompointsextent.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmrandompointsextent.h
3  ---------------------
4  begin : November 2019
5  copyright : (C) 2019 by Clemens Raffler
6  email : clemens dot raffler 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 
19 //Disclaimer: The algorithm optimizes the original Random points in extent algorithm, (C) Alexander Bruy, 2014
20 
21 #ifndef QGSALGORITHMRANDOMPOINTSEXTENT_H
22 #define QGSALGORITHMRANDOMPOINTSEXTENT_H
23 
24 #define SIP_NO_FILE
25 
26 #include "qgis_sip.h"
27 #include "qgsprocessingalgorithm.h"
28 #include "qgsapplication.h"
29 
31 
35 class QgsRandomPointsExtentAlgorithm : public QgsProcessingAlgorithm
36 {
37  public:
38 
39  QgsRandomPointsExtentAlgorithm() = default;
40  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
41  QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmRandomPointsWithinExtent.svg" ) ); }
42  QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmRandomPointsWithinExtent.svg" ) ); }
43  QString name() const override;
44  QString displayName() const override;
45  QStringList tags() const override;
46  QString group() const override;
47  QString groupId() const override;
48  QString shortHelpString() const override;
49  QgsRandomPointsExtentAlgorithm *createInstance() const override SIP_FACTORY;
50 
51  protected:
52  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
53  QVariantMap processAlgorithm( const QVariantMap &parameters,
54  QgsProcessingContext &context,
55  QgsProcessingFeedback *feedback ) override;
56 
57 
58  private:
59  QgsRectangle mExtent;
60  int mNumPoints;
61  double mDistance;
62  int mMaxAttempts;
64 
65 };
66 
67 
69 
70 #endif // QGSALGORITHMRANDOMPOINTSEXTENT_H
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
This class represents a coordinate reference system (CRS).
Abstract base class for processing algorithms.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
A rectangle specified with double values.
Definition: qgsrectangle.h:42
#define SIP_FACTORY
Definition: qgis_sip.h:76