Branch data     Line data    Source code

       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_sip.h"
      24                 :            : #include "qgsprocessingalgorithm.h"
      25                 :            : 
      26                 :            : ///@cond PRIVATE
      27                 :            : 
      28                 :            : /**
      29                 :            :  * Native transect algorithm.
      30                 :            :  */
      31                 :          0 : class QgsTransectAlgorithm : public QgsProcessingAlgorithm
      32                 :            : {
      33                 :            : 
      34                 :            :   public:
      35                 :            : 
      36                 :            :     /**
      37                 :            :      * Draw the transect on which side of the line
      38                 :            :      */
      39                 :            :     enum Side
      40                 :            :     {
      41                 :            :       Left,
      42                 :            :       Right,
      43                 :            :       Both
      44                 :            :     };
      45                 :          0 :     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                 :            : 
      62                 :            :     /**
      63                 :            :      * Returns the transect of the point \a point with \a length, \a orientation and \a angle.
      64                 :            :      * \param point The vertex
      65                 :            :      * \param angleAtVertex Angle at the vertex
      66                 :            :      * \param length Length of the transect Distance to extend line from input feature
      67                 :            :      * \param orientation Orientation of the transect
      68                 :            :      * \param angle Angle of the transect relative to the segment [\a p1 - \a p2] (degrees clockwise)
      69                 :            :      */
      70                 :            :     QgsGeometry calcTransect( const QgsPoint &point, double angleAtVertex, double length, Side orientation, double angle );
      71                 :            : };
      72                 :            : 
      73                 :            : ///@endcond PRIVATE
      74                 :            : 
      75                 :            : #endif // QGSALGORITHMTRANSECT_H