QGIS API Documentation 3.41.0-Master (cea29feecf2)
Loading...
Searching...
No Matches
qgsalgorithmrandompointsinpolygons.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmrandompointsinpolygons.h
3 ---------------------
4 begin : March 2020
5 copyright : (C) 2020 by HÃ¥vard Tveite
6 email : havard dot tveite at nmbu dot no
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
19#ifndef QGSALGORITHMRANDOMPOINTSINPOLYGONS_H
20#define QGSALGORITHMRANDOMPOINTSINPOLYGONS_H
21
22#define SIP_NO_FILE
23
24#include "qgis_sip.h"
26#include "qgsapplication.h"
27
29
33class QgsRandomPointsInPolygonsAlgorithm : public QgsProcessingAlgorithm
34{
35 public:
36 QgsRandomPointsInPolygonsAlgorithm() = default;
37 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
38 QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmRandomPointsInPolygons.svg" ) ); }
39 QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmRandomPointsInPolygons.svg" ) ); }
40 QString name() const override;
41 QString displayName() const override;
42 QStringList tags() const override;
43 QString group() const override;
44 QString groupId() const override;
45 QString shortHelpString() const override;
46 QgsRandomPointsInPolygonsAlgorithm *createInstance() const override SIP_FACTORY;
47
48 protected:
49 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
50 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
51
52 private:
53 // The algorithm parameter names:
54 static inline const QString INPUT = QStringLiteral( "INPUT" );
55 static inline const QString POINTS_NUMBER = QStringLiteral( "POINTS_NUMBER" );
56 static inline const QString MIN_DISTANCE_GLOBAL = QStringLiteral( "MIN_DISTANCE_GLOBAL" );
57 static inline const QString MIN_DISTANCE = QStringLiteral( "MIN_DISTANCE" );
58 static inline const QString MAX_TRIES_PER_POINT = QStringLiteral( "MAX_TRIES_PER_POINT" );
59 static inline const QString SEED = QStringLiteral( "SEED" );
60 static inline const QString INCLUDE_POLYGON_ATTRIBUTES = QStringLiteral( "INCLUDE_POLYGON_ATTRIBUTES" );
61 static inline const QString OUTPUT = QStringLiteral( "OUTPUT" );
62 static inline const QString OUTPUT_POINTS = QStringLiteral( "OUTPUT_POINTS" );
63 static inline const QString POINTS_MISSED = QStringLiteral( "POINTS_MISSED" );
64 static inline const QString POLYGONS_WITH_MISSED_POINTS = QStringLiteral( "POLYGONS_WITH_MISSED_POINTS" );
65 static inline const QString FEATURES_WITH_EMPTY_OR_NO_GEOMETRY = QStringLiteral( "FEATURES_WITH_EMPTY_OR_NO_GEOMETRY" );
66
67 int mNumPoints = 0;
68 bool mDynamicNumPoints = false;
69 QgsProperty mNumPointsProperty;
70
71 double mMinDistance = 0;
72 bool mDynamicMinDistance = false;
73 QgsProperty mMinDistanceProperty;
74
75 double mMinDistanceGlobal = 0;
76
77 int mMaxAttempts = 10;
78 bool mDynamicMaxAttempts = false;
79 QgsProperty mMaxAttemptsProperty;
80
81 bool mUseRandomSeed = false;
82 int mRandSeed = 0;
83 bool mIncludePolygonAttr = false;
84};
85
87
88#endif // QGSALGORITHMRANDOMPOINTSINPOLYGONS_H
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
Abstract base class for processing algorithms.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
A store for object properties.
#define SIP_FACTORY
Definition qgis_sip.h:76