QGIS API Documentation 3.39.0-Master (67e056379ed)
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 void initParameters( const QVariantMap &configuration = QVariantMap() ) override final;
40 QString shortHelpString() const override final;
41
42 protected:
43 QString outputName() const override final;
44 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override final;
45 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback *feedback ) override final;
46
47 private:
48
49 double mMin = 0.0;
50 bool mDynamicMin = false;
51 QgsProperty mMinProperty;
52
53 double mMax = 0.0;
54 bool mDynamicMax = false;
55 QgsProperty mMaxProperty;
56
57 virtual QString componentString() const = 0;
58 virtual void filter( QgsGeometry &geometry, double min, double max ) const = 0;
59};
60
64class QgsFilterVerticesByM : public QgsFilterVerticesAlgorithmBase
65{
66
67 public:
68
69 QgsFilterVerticesByM() = default;
70 QString name() const override;
71 QString displayName() const override;
72 QStringList tags() const override;
73 QgsFilterVerticesByM *createInstance() const override SIP_FACTORY;
74 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
75
76 private:
77
78 QString componentString() const override;
79 void filter( QgsGeometry &geometry, double min, double max ) const override;
80};
81
85class QgsFilterVerticesByZ : public QgsFilterVerticesAlgorithmBase
86{
87
88 public:
89
90 QgsFilterVerticesByZ() = default;
91 QString name() const override;
92 QString displayName() const override;
93 QStringList tags() const override;
94 QgsFilterVerticesByZ *createInstance() const override SIP_FACTORY;
95 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
96
97 private:
98
99 QString componentString() const override;
100 void filter( QgsGeometry &geometry, double min, double max ) const override;
101};
102
104
105#endif // QGSALGORITHMFILTERVERTICES_H
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
A geometry is the spatial representation of a feature.
Base class for all map layer types.
Definition qgsmaplayer.h:75
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.
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