QGIS API Documentation  3.21.0-Master (56b4176581)
qgsalgorithmtaperedbuffer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmtaperedbuffer.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 QGSALGORITHMTAPEREDBUFFER_H
19 #define QGSALGORITHMTAPEREDBUFFER_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_core.h"
24 #include "qgis_sip.h"
25 #include "qgsprocessingalgorithm.h"
26 
28 
32 class QgsTaperedBufferAlgorithm : public QgsProcessingFeatureBasedAlgorithm
33 {
34 
35  public:
36 
37  QgsTaperedBufferAlgorithm() = 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  QList<int> inputLayerTypes() const override;
45  QgsTaperedBufferAlgorithm *createInstance() const override SIP_FACTORY;
46  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
47 
48  protected:
49  QString outputName() const override;
50  QgsProcessing::SourceType outputLayerType() const override;
51  QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type ) const override;
52  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
54 
55  private:
56 
57  double mStartWidth = 0.0;
58  bool mDynamicStartWidth = false;
59  QgsProperty mStartWidthProperty;
60 
61  double mEndWidth = 1.0;
62  bool mDynamicEndWidth = false;
63  QgsProperty mEndWidthProperty;
64 
65  int mSegments = 16;
66  bool mDynamicSegments = false;
67  QgsProperty mSegmentsProperty;
68 
69 };
70 
71 
75 class QgsVariableWidthBufferByMAlgorithm : public QgsProcessingFeatureBasedAlgorithm
76 {
77 
78  public:
79 
80  QgsVariableWidthBufferByMAlgorithm() = default;
81  QString name() const override;
82  QString displayName() const override;
83  QStringList tags() const override;
84  QString group() const override;
85  QString groupId() const override;
86  QString shortHelpString() const override;
87  QList<int> inputLayerTypes() const override;
88  QgsVariableWidthBufferByMAlgorithm *createInstance() const override SIP_FACTORY;
89  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
90 
91  protected:
92  QString outputName() const override;
93  QgsProcessing::SourceType outputLayerType() const override;
94  QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type ) const override;
95  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
96  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
97 
98  private:
99 
100  int mSegments = 16;
101  bool mDynamicSegments = false;
102  QgsProperty mSegmentsProperty;
103 
104 };
106 
107 #endif // QGSALGORITHMTAPEREDBUFFER_H
108 
109 
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...
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
Base class for providing feedback from a processing algorithm.
Contains enumerations and other constants for use in processing algorithms and parameters.
Definition: qgsprocessing.h:40
SourceType
Data source types enum.
Definition: qgsprocessing.h:46
A store for object properties.
Definition: qgsproperty.h:232
Handles storage of information regarding WKB types and their properties.
Definition: qgswkbtypes.h:42
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:70
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:834