QGIS API Documentation  3.21.0-Master (56b4176581)
qgsalgorithmsnaptogrid.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmsnaptogrid.h
3  ---------------------
4  begin : October 2017
5  copyright : (C) 2017 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 #ifndef QGSALGORITHMSNAPTOGRID_H
19 #define QGSALGORITHMSNAPTOGRID_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsSnapToGridAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32 {
33 
34  public:
35 
36  QgsSnapToGridAlgorithm() = default;
37  QString name() const override;
38  QString displayName() const override;
39  QStringList tags() const override;
40  QString group() const override;
41  QString groupId() const override;
42  QString shortHelpString() const override;
43  QgsSnapToGridAlgorithm *createInstance() const override SIP_FACTORY;
44  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
45 
46  protected:
47  QString outputName() const override;
48  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
49  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
50  QgsProcessingFeatureSource::Flag sourceFlags() const override;
51 
52  private:
53  double mIntervalX = 0.0;
54  bool mDynamicIntervalX = false;
55  QgsProperty mIntervalXProperty;
56 
57  double mIntervalY = 0.0;
58  bool mDynamicIntervalY = false;
59  QgsProperty mIntervalYProperty;
60 
61  double mIntervalZ = 0.0;
62  bool mDynamicIntervalZ = false;
63  QgsProperty mIntervalZProperty;
64 
65  double mIntervalM = 0.0;
66  bool mDynamicIntervalM = false;
67  QgsProperty mIntervalMProperty;
68 
69 };
70 
72 
73 #endif // QGSALGORITHMSNAPTOGRID_H
74 
75 
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
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 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 name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
Base class for providing feedback from a processing algorithm.
A store for object properties.
Definition: qgsproperty.h:232
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:834