QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
qgsalgorithmfiltervertices.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmfiltervertices.h
3 ----------------------------
4 begin : July 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 QGSALGORITHMFILTERVERTICES_H
19#define QGSALGORITHMFILTERVERTICES_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
26
28
32class QgsFilterVerticesAlgorithmBase : public QgsProcessingFeatureBasedAlgorithm
33{
34
35 public:
36
37 QString group() const override final;
38 QString groupId() const override final;
39 QList<int> inputLayerTypes() const override final;
40 void initParameters( const QVariantMap &configuration = QVariantMap() ) override final;
41 QString shortHelpString() const override final;
42
43 protected:
44 QString outputName() const override final;
45 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override final;
46 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback *feedback ) override final;
47
48 private:
49
50 double mMin = 0.0;
51 bool mDynamicMin = false;
52 QgsProperty mMinProperty;
53
54 double mMax = 0.0;
55 bool mDynamicMax = false;
56 QgsProperty mMaxProperty;
57
58 virtual QString componentString() const = 0;
59 virtual void filter( QgsGeometry &geometry, double min, double max ) const = 0;
60};
61
65class QgsFilterVerticesByM : public QgsFilterVerticesAlgorithmBase
66{
67
68 public:
69
70 QgsFilterVerticesByM() = default;
71 QString name() const override;
72 QString displayName() const override;
73 QStringList tags() const override;
74 QgsFilterVerticesByM *createInstance() const override SIP_FACTORY;
75 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
76
77 private:
78
79 QString componentString() const override;
80 void filter( QgsGeometry &geometry, double min, double max ) const override;
81
82};
83
84
88class QgsFilterVerticesByZ : public QgsFilterVerticesAlgorithmBase
89{
90
91 public:
92
93 QgsFilterVerticesByZ() = default;
94 QString name() const override;
95 QString displayName() const override;
96 QStringList tags() const override;
97 QgsFilterVerticesByZ *createInstance() const override SIP_FACTORY;
98 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
99
100 private:
101
102 QString componentString() const override;
103 void filter( QgsGeometry &geometry, double min, double max ) const override;
104};
105
106
108
109#endif // QGSALGORITHMFILTERVERTICES_H
110
111
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:56
A geometry is the spatial representation of a feature.
Base class for all map layer types.
Definition qgsmaplayer.h:74
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)
Prepares the algorithm to run using the specified parameters.
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.
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 QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback)=0
Processes an individual input feature from the source.
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
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.
A store for object properties.
#define SIP_FACTORY
Definition qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition qgsfeature.h:920