qgsmaptoolextraitem.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaptoolextraitem.h
    ---------------------
    begin                : 2026/01/22
    copyright            : (C) 2026 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 QGSMAPTOOLEXTRAITEM_H
#define QGSMAPTOOLEXTRAITEM_H
 
#include "qgsgraphicsviewmousehandles.h"
#include "qgsmapcanvas.h"
#include "qgsmaptool.h"
#include "qgspropertyoverridebutton.h"
#include "qgsrubberband.h"
#include "qobjectuniqueptr.h"
 
#define SIP_NO_FILE
 
class QgsTemplatedLineSymbolLayerBase;
class QgsMapToolModifyExtraItems;
class QgsExtraItemRubberBand;

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

    enum State
    {
      SelectFeature,  
      FeatureSelected 
    };
 
  protected:
    void loadFeatureExtraItems();
    void updateAttribute();

    void selectFeature( QgsMapMouseEvent *event );
 
    QPointer<QgsVectorLayer> mLayer;
    QgsTemplatedLineSymbolLayerBase *mSymbolLayer = nullptr;
    int mExtraItemsFieldIndex = -1;
    QgsFeatureId mFeatureId = FID_NULL;
    State mState = SelectFeature;
    std::vector<QObjectUniquePtr<QgsExtraItemRubberBand>> mExtraItems;
    QgsPropertyOverrideButton *mPropertyButton = nullptr;
 
    friend class TestQgsMapToolExtraItem;
};

class GUI_EXPORT QgsMapToolAddExtraItem : public QgsMapToolExtraItemBase
{
    Q_OBJECT
 
  public:
    QgsMapToolAddExtraItem( QgsMapCanvas *canvas, QgsVectorLayer *layer, QgsTemplatedLineSymbolLayerBase *symbolLayer, QgsPropertyOverrideButton *propertyButton );
 
    void canvasPressEvent( QgsMapMouseEvent *e ) override;
    void keyPressEvent( QKeyEvent *event ) override;
 
  private:
    friend class TestQgsMapToolExtraItem;
};

class GUI_EXPORT QgsMapToolModifyExtraItems : public QgsMapToolExtraItemBase
{
    Q_OBJECT
 
  public:
    QgsMapToolModifyExtraItems( QgsMapCanvas *canvas, QgsVectorLayer *layer, QgsTemplatedLineSymbolLayerBase *symbolLayer, QgsPropertyOverrideButton *propertyButton );
 
    void activate() override;
    void deactivate() override;

    QList<QGraphicsItem *> selectedItems() const;
 
    void canvasPressEvent( QgsMapMouseEvent *event ) override;
    void canvasMoveEvent( QgsMapMouseEvent *event ) override;
    void canvasReleaseEvent( QgsMapMouseEvent *event ) override;
    void keyPressEvent( QKeyEvent *event ) override;

    void attemptMoveBy( QGraphicsItem *item, double deltaX, double deltaY );

    void attemptRotateBy( QGraphicsItem *item, double deltaDegree, double deltaCenterX, double deltaCenterY );
 
  signals:

    void selectedItemsChanged();
 
  private slots:

    void onMapCanvasExtentsChanged();
 
  private:
    QgsPointXY movePosition( const QgsPointXY &position, double deltaX, double deltaY ) const;

    class QgsMapToolModifyExtraItemMouseHandles : public QgsGraphicsViewMouseHandles
    {
      public:
        QgsMapToolModifyExtraItemMouseHandles( QgsMapToolModifyExtraItems *mapTool, QgsMapCanvas *canvas );
 
        void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget ) override;
        void setViewportCursor( Qt::CursorShape cursor ) override;
        QList<QGraphicsItem *> sceneItemsAtPoint( QPointF scenePoint ) override;
        QList<QGraphicsItem *> selectedSceneItems( bool includeLockedItems = true ) const override;
        QRectF itemRect( QGraphicsItem *item ) const override;
        void moveItem( QGraphicsItem *item, double deltaX, double deltaY ) override;
        void rotateItem( QGraphicsItem *item, double deltaDegree, double deltaCenterX, double deltaCenterY ) override;
        void setItemRect( QGraphicsItem *item, QRectF rect ) override;
 
        using QgsGraphicsViewMouseHandles::hoverMoveEvent;
        using QgsGraphicsViewMouseHandles::mouseMoveEvent;
        using QgsGraphicsViewMouseHandles::mousePressEvent;
        using QgsGraphicsViewMouseHandles::mouseReleaseEvent;
        using QgsGraphicsViewMouseHandles::updateHandles;
 
      private:
        QgsMapToolModifyExtraItems *mMapTool = nullptr;
        QgsMapCanvas *mCanvas = nullptr;
 
        friend class TestQgsMapToolExtraItem;
    };
 
    QList<QGraphicsItem *> mSelectedItems;
    QList<std::tuple<double, double, double>> mCopiedItems;
    QObjectUniquePtr<QgsMapToolModifyExtraItemMouseHandles> mMouseHandles;
    bool mHoveringMouseHandles = false;
    bool mCanceled = false;
    bool mDragging = false;
    QRect mSelectionRect;
    QPoint mLastPos;
    QPointF mCopiedItemsTopLeft;
    QObjectUniquePtr<QgsRubberBand> mSelectionRubberBand;
 
    friend class TestQgsMapToolExtraItem;
};
 
#endif