qgsmodelgraphicsscene.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmodelgraphicsscene.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 QGSMODELGRAPHICSCENE_H
#define QGSMODELGRAPHICSCENE_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsprocessingcontext.h"
#include <QGraphicsScene>
 
class QgsProcessingModelAlgorithm;
class QgsModelComponentGraphicItem;
class QgsProcessingModelParameter;
class QgsProcessingModelChildAlgorithm;
class QgsProcessingModelOutput;
class QgsProcessingModelComponent;
class QgsProcessingModelComment;
class QgsModelChildAlgorithmGraphicItem;
class QgsProcessingModelGroupBox;
class QgsMessageBar;
 
 
class GUI_EXPORT QgsModelGraphicsScene : public QGraphicsScene
{
    Q_OBJECT
 
  public:
 
    enum ZValues
    {
      GroupBox = 0, 
      ArrowLink = 1, 
      ModelComponent = 2, 
      MouseHandles = 99, 
      RubberBand = 100, 
      ZSnapIndicator = 101, 
 
    };
 
    enum Flag
    {
      FlagHideControls = 1 << 1,  
      FlagHideComments = 1 << 2, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    
    QgsModelGraphicsScene( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    QgsProcessingModelAlgorithm *model();
 
    void setModel( QgsProcessingModelAlgorithm *model );
 
    void setFlags( QgsModelGraphicsScene::Flags flags ) { mFlags = flags; }
 
    void setFlag( QgsModelGraphicsScene::Flag flag, bool on = true );
 
    QgsModelGraphicsScene::Flags flags() const { return mFlags; }
 
    void mousePressEvent( QGraphicsSceneMouseEvent *event ) override;
 
    void createItems( QgsProcessingModelAlgorithm *model, QgsProcessingContext &context );
 
    QList<QgsModelComponentGraphicItem *> selectedComponentItems();
 
    QgsModelComponentGraphicItem *componentItemAt( QPointF position ) const;
 
    QgsModelComponentGraphicItem *groupBoxItem( const QString &uuid );
 
    void selectAll();
 
    void deselectAll();
 
    void setSelectedItem( QgsModelComponentGraphicItem *item );
 
    void setChildAlgorithmResults( const QVariantMap &results );
 
    void setChildAlgorithmInputs( const QVariantMap &inputs );
 
    QgsMessageBar *messageBar() const;
 
    void setMessageBar( QgsMessageBar *bar );
 
    void showWarning( const QString &shortMessage, const QString &title, const QString &longMessage, Qgis::MessageLevel level = Qgis::MessageLevel::Warning ) const;
 
  signals:
 
    void rebuildRequired();
 
    void componentAboutToChange( const QString &text, int id = 0 );
 
    void componentChanged();
 
    void selectedItemChanged( QgsModelComponentGraphicItem *selected );
 
  protected:
 
    virtual QgsModelComponentGraphicItem *createParameterGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelParameter *param ) const SIP_FACTORY;
 
    virtual QgsModelChildAlgorithmGraphicItem *createChildAlgGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelChildAlgorithm *child ) const  SIP_FACTORY;
 
    virtual QgsModelComponentGraphicItem *createOutputGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelOutput *output ) const SIP_FACTORY;
 
    virtual QgsModelComponentGraphicItem *createCommentGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelComment *comment,
        QgsModelComponentGraphicItem *parentItem ) const SIP_FACTORY;
 
    QgsModelComponentGraphicItem *createGroupBoxGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelGroupBox *box ) const SIP_FACTORY;
 
  private:
 
    struct LinkSource
    {
      QgsModelComponentGraphicItem *item = nullptr;
      Qt::Edge edge = Qt::LeftEdge;
      int linkIndex = -1;
    };
    QList< LinkSource > linkSourcesForParameterValue( QgsProcessingModelAlgorithm *model, const QVariant &value, const QString &childId, QgsProcessingContext &context ) const;
 
    void addCommentItemForComponent( QgsProcessingModelAlgorithm *model, const QgsProcessingModelComponent &component, QgsModelComponentGraphicItem *parentItem );
 
    Flags mFlags = Flags();
 
    QgsProcessingModelAlgorithm *mModel = nullptr;
 
    QMap< QString, QgsModelComponentGraphicItem * > mParameterItems;
    QMap< QString, QgsModelChildAlgorithmGraphicItem * > mChildAlgorithmItems;
    QMap< QString, QMap< QString, QgsModelComponentGraphicItem * > > mOutputItems;
    QMap< QString, QgsModelComponentGraphicItem * > mGroupBoxItems;
    QVariantMap mChildResults;
    QVariantMap mChildInputs;
 
    QgsMessageBar *mMessageBar = nullptr;
 
};
 
Q_DECLARE_METATYPE( QgsModelGraphicsScene::Flags )
 
 
#endif // QGSMODELCOMPONENTGRAPHICITEM_H