QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsalgorithmgrid.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmgrid.h
3  ---------------------
4  begin : August 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:This feature was developed by: Michael Minn, 201
20 
21 #ifndef QGSALGORITHMGRID_H
22 #define QGSALGORITHMGRID_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 QgsGridAlgorithm : public QgsProcessingAlgorithm
36 {
37  public:
38 
39  QgsGridAlgorithm() = default;
40  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
41  QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmCreateGrid.svg" ) ); }
42  QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmCreateGrid.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  QgsGridAlgorithm *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  int mIdx;
60  QgsRectangle mGridExtent;
62  double mHSpacing;
63  double mVSpacing;
64  double mHOverlay;
65  double mVOverlay;
66 
67  //define grid creation methods
68  void createPointGrid( std::unique_ptr< QgsFeatureSink > &sink, QgsProcessingFeedback *feedback );
69  void createLineGrid( std::unique_ptr< QgsFeatureSink > &sink, QgsProcessingFeedback *feedback );
70  void createRectangleGrid( std::unique_ptr< QgsFeatureSink > &sink, QgsProcessingFeedback *feedback );
71  void createDiamondGrid( std::unique_ptr< QgsFeatureSink> &sink, QgsProcessingFeedback *feedback );
72  void createHexagonGrid( std::unique_ptr< QgsFeatureSink> &sink, QgsProcessingFeedback *feedback );
73 };
74 
75 
77 
78 #endif // QGISALGORITHMGRID_H
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
A rectangle specified with double values.
Definition: qgsrectangle.h:41
virtual QIcon icon() const
Returns an icon for the algorithm.
Base class for providing feedback from a processing algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
static QIcon getThemeIcon(const QString &name)
Helper to get a theme icon.
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 shortHelpString() const
Returns a localised short helper string for the algorithm.
Abstract base class for processing algorithms.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
This class represents a coordinate reference system (CRS).
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Contains information about the context in which a processing algorithm is executed.
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm&#39;s icon.