QGIS API Documentation  3.4.15-Madeira (e83d02e274)
qgsalgorithmtransect.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmtransect.h
3  -------------------------
4  begin : October 2017
5  copyright : (C) 2017 by Loïc Bartoletti
6  email : lbartoletti at tuxfamily dot org
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 QGSALGORITHMTRANSECT_H
19 #define QGSALGORITHMTRANSECT_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsTransectAlgorithm : public QgsProcessingAlgorithm
32 {
33 
34  public:
35 
39  enum Side
40  {
41  Left,
42  Right,
43  Both
44  };
45  QgsTransectAlgorithm() = default;
46  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
47  QString name() const override;
48  QString displayName() const override;
49  QStringList tags() const override;
50  QString group() const override;
51  QString groupId() const override;
52  QString shortHelpString() const override;
53  QgsTransectAlgorithm *createInstance() const override SIP_FACTORY;
54 
55  protected:
56 
57  QVariantMap processAlgorithm( const QVariantMap &parameters,
58  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
59 
60  private:
61 
70  QgsGeometry calcTransect( const QgsPoint &point, double angleAtVertex, double length, Side orientation, double angle );
71 };
72 
74 
75 #endif // QGSALGORITHMTRANSECT_H
Base class for providing feedback from a processing algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:106
Abstract base class for processing algorithms.
double ANALYSIS_EXPORT angle(QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored)
Definition: MathUtils.cpp:786
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
#define SIP_FACTORY
Definition: qgis_sip.h:69
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Contains information about the context in which a processing algorithm is executed.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.