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