qgsalgorithmtransectbase.h

Go to the documentation of this file.

/***************************************************************************
                         qgsalgorithmtransectbase.h
                         -------------------------
    begin                : September 2025
    copyright            : (C) 2025 by Loïc Bartoletti
    email                : loic dot bartoletti at oslandia dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSALGORITHMTRANSECTBASE_H
#define QGSALGORITHMTRANSECTBASE_H
 
 
#include "qgis_sip.h"
#include "qgsprocessingalgorithm.h"
 
#define SIP_NO_FILE


class QgsTransectAlgorithmBase : public QgsProcessingAlgorithm
{
  public:
    enum Side
    {
      Left,
      Right,
      Both
    };

    enum Direction
    {
      RightToLeft,
      LeftToRight
    };
 
    QString group() const final;
    QString groupId() const final;
    QStringList tags() const override;
    QString shortDescription() const override;
    Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const final;
    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) final;
 
  protected:
    virtual void addAlgorithmParams() = 0;

    virtual bool
      prepareAlgorithmTransectParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      = 0;

    QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;

    virtual std::vector<QgsPoint>
      generateSamplingPoints( const QgsLineString &line, const QVariantMap &parameters, QgsProcessingContext &context ) = 0;

    virtual double calculateAzimuth( const QgsLineString &line, const QgsPoint &point, int pointIndex ) = 0;

    static QgsGeometry calcTransect( const QgsPoint &point, double angleAtVertex, double length, Side orientation, double angle, Direction direction );
 
    // Shared member variables accessible to subclasses
    Side mOrientation = Both;
    double mAngle = 90.0;
    double mLength = 5.0;
    bool mDynamicAngle = false;
    bool mDynamicLength = false;
    Direction mDirection = RightToLeft;
    QgsProperty mAngleProperty;
    QgsProperty mLengthProperty;
};

 
#endif // QGSALGORITHMTRANSECTBASE_H