QGIS API Documentation 3.43.0-Master (e01d6d7c4c0)
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 public:
35 QString group() const override final;
36 QString groupId() const override final;
37 void initParameters( const QVariantMap &configuration = QVariantMap() ) override final;
38 QString shortHelpString() const override final;
39 QString shortDescription() const override;
40
41 protected:
42 QString outputName() const override final;
43 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override final;
44 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback *feedback ) override final;
45
46 private:
47 double mMin = 0.0;
48 bool mDynamicMin = false;
49 QgsProperty mMinProperty;
50
51 double mMax = 0.0;
52 bool mDynamicMax = false;
53 QgsProperty mMaxProperty;
54
55 virtual QString componentString() const = 0;
56 virtual void filter( QgsGeometry &geometry, double min, double max ) const = 0;
57};
58
62class QgsFilterVerticesByM : public QgsFilterVerticesAlgorithmBase
63{
64 public:
65 QgsFilterVerticesByM() = default;
66 QString name() const override;
67 QString displayName() const override;
68 QStringList tags() const override;
69 QgsFilterVerticesByM *createInstance() const override SIP_FACTORY;
70 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
71
72 private:
73 QString componentString() const override;
74 void filter( QgsGeometry &geometry, double min, double max ) const override;
75};
76
80class QgsFilterVerticesByZ : public QgsFilterVerticesAlgorithmBase
81{
82 public:
83 QgsFilterVerticesByZ() = default;
84 QString name() const override;
85 QString displayName() const override;
86 QStringList tags() const override;
87 QgsFilterVerticesByZ *createInstance() const override SIP_FACTORY;
88 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
89
90 private:
91 QString componentString() const override;
92 void filter( QgsGeometry &geometry, double min, double max ) const override;
93};
94
96
97#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:77
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.
virtual QString shortDescription() const
Returns an optional translated short description of 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