QGIS API Documentation 3.99.0-Master (c22de0620c0)
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
22#include "qgis_sip.h"
25
26#define SIP_NO_FILE
27
29
33class QgsFilterVerticesAlgorithmBase : public QgsProcessingFeatureBasedAlgorithm
34{
35 public:
36 QString group() const final;
37 QString groupId() const final;
38 void initParameters( const QVariantMap &configuration = QVariantMap() ) final;
39 QString shortHelpString() const final;
40 QString shortDescription() const override;
41
42 protected:
43 QString outputName() const final;
44 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;
46
47 private:
48 double mMin = 0.0;
49 bool mDynamicMin = false;
50 QgsProperty mMinProperty;
51
52 double mMax = 0.0;
53 bool mDynamicMax = false;
54 QgsProperty mMaxProperty;
55
56 virtual QString componentString() const = 0;
57 virtual void filter( QgsGeometry &geometry, double min, double max ) const = 0;
58};
59
63class QgsFilterVerticesByM : public QgsFilterVerticesAlgorithmBase
64{
65 public:
66 QgsFilterVerticesByM() = default;
67 QString name() const override;
68 QString displayName() const override;
69 QStringList tags() const override;
70 QgsFilterVerticesByM *createInstance() const override SIP_FACTORY;
71 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
72
73 private:
74 QString componentString() const override;
75 void filter( QgsGeometry &geometry, double min, double max ) const override;
76};
77
81class QgsFilterVerticesByZ : public QgsFilterVerticesAlgorithmBase
82{
83 public:
84 QgsFilterVerticesByZ() = default;
85 QString name() const override;
86 QString displayName() const override;
87 QStringList tags() const override;
88 QgsFilterVerticesByZ *createInstance() const override SIP_FACTORY;
89 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
90
91 private:
92 QString componentString() const override;
93 void filter( QgsGeometry &geometry, double min, double max ) const override;
94};
95
97
98#endif // QGSALGORITHMFILTERVERTICES_H
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:60
A geometry is the spatial representation of a feature.
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:83
QList< QgsFeature > QgsFeatureList