qgsmodelcomponentgraphicitem.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmodelcomponentgraphicitem.h
                             ----------------------------------
    Date                 : March 2020
    Copyright            : (C) 2020 Nyall Dawson
    Email                : nyall dot dawson at gmail 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 QGSMODELCOMPONENTGRAPHICITEM_H
#define QGSMODELCOMPONENTGRAPHICITEM_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsprocessingcontext.h"
#include <QGraphicsObject>
#include <QFont>
#include <QPicture>
#include <QPointer>
 
class QgsProcessingModelComponent;
class QgsProcessingModelParameter;
class QgsProcessingModelChildAlgorithm;
class QgsProcessingModelOutput;
class QgsProcessingModelComment;
class QgsProcessingModelAlgorithm;
class QgsModelDesignerFlatButtonGraphicItem;
class QgsModelDesignerFoldButtonGraphicItem;
class QgsModelGraphicsView;
class QgsModelViewMouseEvent;
class QgsProcessingModelGroupBox;
 
 
class GUI_EXPORT QgsModelComponentGraphicItem : public QGraphicsObject
{
    Q_OBJECT
 
  public:
    enum State
    {
      Normal,   
      Selected, 
      Hover,    
    };
 
    enum Flag SIP_ENUM_BASETYPE( IntFlag )
    {
      // For future API flexibility only and to avoid sip issues, remove when real entries are added to flags.
      Unused = 1 << 0, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    
    QgsModelComponentGraphicItem( QgsProcessingModelComponent *component SIP_TRANSFER, QgsProcessingModelAlgorithm *model, QGraphicsItem *parent SIP_TRANSFERTHIS );
 
    ~QgsModelComponentGraphicItem() override;
 
    virtual Flags flags() const;
 
    QgsProcessingModelComponent *component();
 
    const QgsProcessingModelComponent *component() const SIP_SKIP;
 
    QgsProcessingModelAlgorithm *model();
 
    QgsModelGraphicsView *view();
 
    QFont font() const;
 
    void setFont( const QFont &font );
 
    void moveComponentBy( qreal dx, qreal dy );
 
    void previewItemMove( qreal dx, qreal dy );
 
    void setItemRect( QRectF rect );
 
#ifndef SIP_RUN
 
    QRectF previewItemRectChange( QRectF rect );
 
    void finalizePreviewedItemRectChange( QRectF rect );
 
    virtual void modelHoverEnterEvent( QgsModelViewMouseEvent *event );
 
    virtual void modelHoverMoveEvent( QgsModelViewMouseEvent *event );
 
    virtual void modelHoverLeaveEvent( QgsModelViewMouseEvent *event );
 
    virtual void modelDoubleClickEvent( QgsModelViewMouseEvent *event );
#endif
    void mouseDoubleClickEvent( QGraphicsSceneMouseEvent *event ) override;
    void hoverEnterEvent( QGraphicsSceneHoverEvent *event ) override;
    void hoverMoveEvent( QGraphicsSceneHoverEvent *event ) override;
    void hoverLeaveEvent( QGraphicsSceneHoverEvent *event ) override;
    QVariant itemChange( GraphicsItemChange change, const QVariant &value ) override;
    QRectF boundingRect() const override;
    bool contains( const QPointF &point ) const override;
    void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr ) override;
 
    QRectF itemRect( bool storedRect = false ) const;
 
    QString label() const;
 
    void setLabel( const QString &label );
 
    State state() const;
 
    virtual int linkPointCount( Qt::Edge edge ) const;
 
    virtual QString linkPointText( Qt::Edge edge, int index ) const;
 
    QPointF linkPoint( Qt::Edge edge, int index, bool incoming ) const;
 
    QPointF calculateAutomaticLinkPoint( QgsModelComponentGraphicItem *other, Qt::Edge &edge SIP_OUT ) const;
 
    QPointF calculateAutomaticLinkPoint( const QPointF &point, Qt::Edge &edge SIP_OUT ) const;
 
    virtual void editComment() {}
 
    virtual bool canDeleteComponent() { return false; }
 
    virtual void deleteComponent() {}
 
  signals:
 
    // TODO - rework this, should be triggered externally when the model actually changes!
 
    void requestModelRepaint();
 
    void aboutToChange( const QString &text, int id = 0 );
 
    void changed();
 
    void repaintArrows();
 
    void updateArrowPaths();
 
    void sizePositionChanged();
 
  protected slots:
 
    virtual void editComponent() {}
 
  protected:
    QString truncatedTextForItem( const QString &text ) const;
 
    virtual QColor fillColor( State state ) const = 0;
 
    virtual QColor strokeColor( State state ) const = 0;
 
    virtual QColor textColor( State state ) const = 0;
 
    virtual Qt::PenStyle strokeStyle( State state ) const;
 
    virtual Qt::Alignment titleAlignment() const;
 
    virtual QPicture iconPicture() const;
 
    virtual QPixmap iconPixmap() const;
 
    virtual void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) = 0;
 
    void updateButtonPositions();
 
  private:
    QSizeF itemSize() const;
 
    void updateToolTip( const QPointF &pos );
 
    void fold( Qt::Edge edge, bool folded );
 
    std::unique_ptr<QgsProcessingModelComponent> mComponent;
    QgsProcessingModelAlgorithm *mModel = nullptr;
 
    bool mInitialized = false;
    QgsModelDesignerFoldButtonGraphicItem *mExpandTopButton = nullptr;
    QgsModelDesignerFoldButtonGraphicItem *mExpandBottomButton = nullptr;
 
    QString mLabel;
 
    QgsModelDesignerFlatButtonGraphicItem *mEditButton = nullptr;
    QgsModelDesignerFlatButtonGraphicItem *mDeleteButton = nullptr;
 
    static constexpr double MIN_COMPONENT_WIDTH = 70;
    static constexpr double MIN_COMPONENT_HEIGHT = 30;
 
    static constexpr double DEFAULT_BUTTON_WIDTH = 16;
    static constexpr double DEFAULT_BUTTON_HEIGHT = 16;
    static constexpr double BUTTON_MARGIN = 2;
    static constexpr double TEXT_MARGIN = 4;
    static constexpr double RECT_PEN_SIZE = 2;
    QSizeF mButtonSize { DEFAULT_BUTTON_WIDTH, DEFAULT_BUTTON_HEIGHT };
 
    QFont mFont;
 
    bool mIsHovering = false;
    QSizeF mTempSize;
};
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsModelComponentGraphicItem::Flags )
 
 
class GUI_EXPORT QgsModelParameterGraphicItem : public QgsModelComponentGraphicItem
{
    Q_OBJECT
 
  public:
    QgsModelParameterGraphicItem( QgsProcessingModelParameter *parameter SIP_TRANSFER, QgsProcessingModelAlgorithm *model, QGraphicsItem *parent SIP_TRANSFERTHIS );
 
    void contextMenuEvent( QGraphicsSceneContextMenuEvent *event ) override;
    bool canDeleteComponent() override;
 
  protected:
    QColor fillColor( State state ) const override;
    QColor strokeColor( State state ) const override;
    QColor textColor( State state ) const override;
    QPicture iconPicture() const override;
    void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
 
  protected slots:
 
    void deleteComponent() override;
 
  private:
    QPicture mPicture;
};
 
class GUI_EXPORT QgsModelChildAlgorithmGraphicItem : public QgsModelComponentGraphicItem
{
    Q_OBJECT
 
  public:
    QgsModelChildAlgorithmGraphicItem( QgsProcessingModelChildAlgorithm *child SIP_TRANSFER, QgsProcessingModelAlgorithm *model, QGraphicsItem *parent SIP_TRANSFERTHIS );
    void contextMenuEvent( QGraphicsSceneContextMenuEvent *event ) override;
    bool canDeleteComponent() override;
 
    void setResults( const QgsProcessingModelChildAlgorithmResult &results );
 
  signals:
 
    void runFromHere();
 
    void runSelected();
 
    void showPreviousResults();
 
    void showLog();
 
  protected:
    QColor fillColor( State state ) const override;
    QColor strokeColor( State state ) const override;
    QColor textColor( State state ) const override;
    QPixmap iconPixmap() const override;
    QPicture iconPicture() const override;
 
    int linkPointCount( Qt::Edge edge ) const override;
    QString linkPointText( Qt::Edge edge, int index ) const override;
    void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
 
  protected slots:
 
    void deleteComponent() override;
 
  private slots:
    void deactivateAlgorithm();
    void activateAlgorithm();
 
  private:
    QPicture mPicture;
    QPixmap mPixmap;
    QgsProcessingModelChildAlgorithmResult mResults;
    bool mIsValid = true;
};
 
 
class GUI_EXPORT QgsModelOutputGraphicItem : public QgsModelComponentGraphicItem
{
    Q_OBJECT
 
  public:
    QgsModelOutputGraphicItem( QgsProcessingModelOutput *output SIP_TRANSFER, QgsProcessingModelAlgorithm *model, QGraphicsItem *parent SIP_TRANSFERTHIS );
 
    bool canDeleteComponent() override;
 
  protected:
    QColor fillColor( State state ) const override;
    QColor strokeColor( State state ) const override;
    QColor textColor( State state ) const override;
    QPicture iconPicture() const override;
    void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
 
  protected slots:
 
    void deleteComponent() override;
 
  private:
    QPicture mPicture;
};
 
 
class GUI_EXPORT QgsModelCommentGraphicItem : public QgsModelComponentGraphicItem
{
    Q_OBJECT
 
  public:
    QgsModelCommentGraphicItem( QgsProcessingModelComment *comment SIP_TRANSFER, QgsModelComponentGraphicItem *parentItem, QgsProcessingModelAlgorithm *model, QGraphicsItem *parent SIP_TRANSFERTHIS );
    ~QgsModelCommentGraphicItem() override;
    void contextMenuEvent( QGraphicsSceneContextMenuEvent *event ) override;
    bool canDeleteComponent() override;
 
    QgsModelComponentGraphicItem *parentComponentItem() const;
 
  protected:
    QColor fillColor( State state ) const override;
    QColor strokeColor( State state ) const override;
    QColor textColor( State state ) const override;
    Qt::PenStyle strokeStyle( State state ) const override;
    void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
 
  protected slots:
 
    void deleteComponent() override;
    void editComponent() override;
 
  private:
    QgsProcessingModelComment *modelComponent();
 
    std::unique_ptr<QgsProcessingModelComponent> mParentComponent;
    QPointer<QgsModelComponentGraphicItem> mParentItem;
};
 
 
class GUI_EXPORT QgsModelGroupBoxGraphicItem : public QgsModelComponentGraphicItem
{
    Q_OBJECT
 
  public:
    QgsModelGroupBoxGraphicItem( QgsProcessingModelGroupBox *box SIP_TRANSFER, QgsProcessingModelAlgorithm *model, QGraphicsItem *parent SIP_TRANSFERTHIS );
    ~QgsModelGroupBoxGraphicItem() override;
    void contextMenuEvent( QGraphicsSceneContextMenuEvent *event ) override;
    bool canDeleteComponent() override;
 
  protected:
    QColor fillColor( State state ) const override;
    QColor strokeColor( State state ) const override;
    QColor textColor( State state ) const override;
    Qt::PenStyle strokeStyle( State state ) const override;
    Qt::Alignment titleAlignment() const override;
    void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size ) override;
 
  protected slots:
 
    void deleteComponent() override;
    void editComponent() override;
 
  private:
};
 
 
#endif // QGSMODELCOMPONENTGRAPHICITEM_H