qgsmaptooleditblanksegments.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaptooleditblanksegments.h
    ---------------------
    begin                : 2025/08/19
    copyright            : (C) 2025 by Julien Cabieces
    email                : julien dot cabieces 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 QGSMAPTOOLEDITBLANKSEGMENTS_H
#define QGSMAPTOOLEDITBLANKSEGMENTS_H
 
 
#include "qgsfeatureid.h"
#include "qgslinesymbollayer.h"
#include "qgsmapcanvasitem.h"
#include "qgsmaptool.h"
#include "qgspropertyoverridebutton.h"
#include "qgsrubberband.h"
#include "qgssymbol.h"
#include "qobjectuniqueptr.h"
 
#define SIP_NO_FILE
 
class QgsMapToolBlankSegmentRubberBand;
class QgsVectorLayer;
class QgsSymbol;
class QgsSymbolLayer;

class GUI_EXPORT QgsMapToolEditBlankSegmentsBase : public QgsMapTool
{
    Q_OBJECT
 
  public:
    QgsMapToolEditBlankSegmentsBase( QgsMapCanvas *canvas, QgsVectorLayer *layer, QgsTemplatedLineSymbolLayerBase *symbolLayer, QgsPropertyOverrideButton *propertyButton );

    ~QgsMapToolEditBlankSegmentsBase() override;
 
    void canvasMoveEvent( QgsMapMouseEvent *e ) override;
    void canvasPressEvent( QgsMapMouseEvent *e ) override;
    void keyPressEvent( QKeyEvent *e ) override;
 
    void activate() override;
 
  protected:
    typedef QList<QList<QPolygonF>> FeaturePoints;
    FeaturePoints mPoints;
 
  private:
    QPair<double, double> startEndDistance() const;

    void updateAttribute();

    void loadFeaturePoints();

    virtual QgsTemplatedLineSymbolLayerBase *createRenderedPointsSymbolLayer( const QgsTemplatedLineSymbolLayerBase *original ) = 0;

    int closestBlankSegmentIndex( const QPointF &point, double &distance ) const;

    QPointF closestPoint( const QPointF &point, double &distance, int &partIndex, int &ringIndex, int &pointIndex ) const;

    void updateStartEndRubberBand();

    void updateHoveredBlankSegment( const QPoint &pos );

    void setCurrentBlankSegment( int currentBlankSegmentIndex );

    void selectFeature( QgsMapMouseEvent *event );

    class QgsBlankSegmentRubberBand;

    enum State
    {
      SelectFeature,                   
      FeatureSelected,                 
      BlankSegmentSelected,            
      BlankSegmentModificationStarted, 
      BlankSegmentCreationStarted      
    };
 
    std::vector<QObjectUniquePtr<QgsBlankSegmentRubberBand>> mBlankSegments;
    QgsVectorLayer *mLayer = nullptr;
    std::unique_ptr<QgsSymbol> mSymbol;
    QgsTemplatedLineSymbolLayerBase *mSymbolLayer = nullptr;               // original symbol layer
    QgsTemplatedLineSymbolLayerBase *mRenderedPointsSymbolLayer = nullptr; // original symbol layer clone to retrieve rendered points
 
    int mBlankSegmentsFieldIndex = -1;
    QgsFeatureId mCurrentFeatureId = FID_NULL;
    QgsRectangle mExtent;
    State mState = State::SelectFeature;
    int mCurrentBlankSegmentIndex = -1;
    int mHoveredBlankSegmentIndex = -1;
    QgsPropertyOverrideButton *mPropertyButton = nullptr;
 
    // currently edited blank segment, start point is the fixed point and end point is the currently
    // modified one
    QObjectUniquePtr<QgsBlankSegmentRubberBand> mEditedBlankSegment;
    QObjectUniquePtr<QgsRubberBand> mStartRubberBand;
    QObjectUniquePtr<QgsRubberBand> mEndRubberBand;
 
    friend class TestQgsMapToolEditBlankSegments;
};

template<class T> class GUI_EXPORT QgsMapToolEditBlankSegments : public QgsMapToolEditBlankSegmentsBase
{
  public:
    QgsMapToolEditBlankSegments( QgsMapCanvas *canvas, QgsVectorLayer *layer, QgsTemplatedLineSymbolLayerBase *symbolLayer, QgsPropertyOverrideButton *propertyButton )
      : QgsMapToolEditBlankSegmentsBase( canvas, layer, symbolLayer, propertyButton )
    {}
 
    QgsTemplatedLineSymbolLayerBase *createRenderedPointsSymbolLayer( const QgsTemplatedLineSymbolLayerBase *originalSl ) override
    {
      const T *sl = dynamic_cast<const T *>( originalSl );
      return sl ? new QgsRenderedPointsSymbolLayer( sl, mPoints ) : nullptr;
    }
 
  private:
    class QgsRenderedPointsSymbolLayer : public T
    {
      public:
        QgsRenderedPointsSymbolLayer( const T *original, FeaturePoints &points )
          : T( original->rotateSymbols(), original->interval() )
          , mPoints( points )
        {
          original->copyTemplateSymbolProperties( this );
        }
 
        void renderPolyline( const QPolygonF &points, QgsSymbolRenderContext &context ) override
        {
          const int iPart = context.geometryPartNum() - 1;
          if ( iPart < 0 || QgsRenderedPointsSymbolLayer::mRingIndex < 0 )
            return;
 
          if ( iPart >= mPoints.count() )
            mPoints.resize( iPart + 1 );
 
          QVector<QPolygonF> &rings = mPoints[iPart];
          if ( QgsRenderedPointsSymbolLayer::mRingIndex >= rings.count() )
            rings.resize( QgsRenderedPointsSymbolLayer::mRingIndex + 1 );
 
          rings[QgsRenderedPointsSymbolLayer::mRingIndex] = points;
        }
 
      private:
        FeaturePoints &mPoints;
    };
};
 
 
#endif