QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
qgsalgorithmsinglesidedbuffer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmsinglesidedbuffer.h
3 ---------------------
4 begin : November 2019
5 copyright : (C) 2019 by Alexander Bruy
6 email : alexander dot bruy 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 QGSALGORITHMSINGLESIDEDBUFFER_H
19#define QGSALGORITHMSINGLESIDEDBUFFER_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25
27
31class QgsSingleSidedBufferAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32{
33
34 public:
35
36 QgsSingleSidedBufferAlgorithm() = 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 QList<int> inputLayerTypes() const override;
44 QgsSingleSidedBufferAlgorithm *createInstance() const override SIP_FACTORY;
45 void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
46
47 protected:
48
49 QString outputName() const override;
50 QgsProcessing::SourceType outputLayerType() const override;
51 QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type inputWkbType ) 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 mDistance = 0.0;
58 bool mDynamicDistance = false;
59 QgsProperty mDistanceProperty;
60
61 int mSegments = 0;
62 Qgis::BufferSide mSide;
63 Qgis::JoinStyle mJoinStyle;
64 double mMiterLimit = 0.0;
65};
66
68
69#endif // QGSALGORITHMSINGLESIDEDBUFFER_H
70
71
BufferSide
Side of line to buffer.
Definition: qgis.h:1008
JoinStyle
Join styles for buffers.
Definition: qgis.h:1033
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 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.
SourceType
Data source types enum.
Definition: qgsprocessing.h:46
A store for object properties.
Definition: qgsproperty.h:230
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:922