QGIS API Documentation  3.4.15-Madeira (e83d02e274)
qgsalgorithmsegmentize.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmsegmentize.h
3  ---------------------
4  begin : March 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 #ifndef QGSALGORITHMSEGMENTIZE_H
19 #define QGSALGORITHMSEGMENTIZE_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis.h"
24 #include "qgsprocessingalgorithm.h"
26 
28 
32 class QgsSegmentizeByMaximumDistanceAlgorithm : public QgsProcessingFeatureBasedAlgorithm
33 {
34 
35  public:
36 
37  QgsSegmentizeByMaximumDistanceAlgorithm() = default;
38  QString name() const override;
39  QString displayName() const override;
40  QStringList tags() const override;
41  QString group() const override;
42  QString groupId() const override;
43  QString shortHelpString() const override;
44  QgsSegmentizeByMaximumDistanceAlgorithm *createInstance() const override SIP_FACTORY;
45  QList<int> inputLayerTypes() const override;
46  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
47  bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
48 
49  protected:
50  QString outputName() const override;
51  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53 
54  private:
55 
56  double mTolerance = 1.0;
57  bool mDynamicTolerance = false;
58  QgsProperty mToleranceProperty;
59 
60 };
61 
62 
66 class QgsSegmentizeByMaximumAngleAlgorithm : public QgsProcessingFeatureBasedAlgorithm
67 {
68 
69  public:
70 
71  QgsSegmentizeByMaximumAngleAlgorithm() = default;
72  QString name() const override;
73  QString displayName() const override;
74  QStringList tags() const override;
75  QString group() const override;
76  QString groupId() const override;
77  QString shortHelpString() const override;
78  QgsSegmentizeByMaximumAngleAlgorithm *createInstance() const override SIP_FACTORY;
79  QList<int> inputLayerTypes() const override;
80  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
81  bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
82 
83  protected:
84  QString outputName() const override;
85  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
86  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback *feedback ) override;
87 
88  private:
89 
90  double mTolerance = 1.0;
91  bool mDynamicTolerance = false;
92  QgsProperty mToleranceProperty;
93 
94 };
95 
97 
98 #endif // QGSALGORITHMSEGMENTIZE_H
99 
100 
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Base class for all map layer types.
Definition: qgsmaplayer.h:63
Base class for providing feedback from a processing algorithm.
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Processes an individual input feature from the source.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:571
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
#define SIP_FACTORY
Definition: qgis_sip.h:69
A store for object properties.
Definition: qgsproperty.h:229
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString group() const
Returns the name of the group this algorithm belongs to.
bool supportInPlaceEdit(const QgsMapLayer *layer) const override
Checks whether this algorithm supports in-place editing on the given layer Default implementation for...
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
Contains information about the context in which a processing algorithm is executed.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.