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 QgsModelArrowItem;
class QgsProcessingModelFeedback;
class QgsProcessingWidgetContextGenerator;


class GUI_EXPORT QgsModelGraphicsScene : public QGraphicsScene
{
    Q_OBJECT
 
  public:
    enum ZValues
    {
      GroupBox = 0,         
      ArrowLink = 1,        
      ArrowDecoration = 2,  
      ModelComponent = 10,  
      MouseHandles = 99,    
      RubberBand = 100,     
      ZSnapIndicator = 101, 
 
    };

    enum Flag SIP_ENUM_BASETYPE( IntFlag )
    {
      FlagHideControls = 1 << 1,     
      FlagHideComments = 1 << 2,     
      FlagHideFeatureCount = 1 << 3, 
    };
    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();

    SIP_SKIP QgsModelComponentGraphicItem *componentItemAt( QPointF position ) const;

    SIP_SKIP QgsModelComponentGraphicItem *groupBoxItem( const QString &uuid );

    SIP_SKIP QgsModelChildAlgorithmGraphicItem *childAlgorithmItem( const QString &childId );

    void resetChildAlgorithmItems( const QSet<QString> &childAlgorithmSubset = QSet<QString>() );

    QgsModelComponentGraphicItem *parameterItem( const QString &name );

    QgsModelComponentGraphicItem *outputItem( const QString &childId, const QString &childOutputName );

    void selectAll();

    void deselectAll();

    void setSelectedItem( QgsModelComponentGraphicItem *item );

    void setLastRunResult( const QgsProcessingModelResult &result, QgsProcessingContext &context );

    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;

    void requestRebuildRequired();

    void updateBounds();

    void setupFeedbackConnections( QgsProcessingModelFeedback *feedback ) SIP_SKIP;

    void flagChildrenAsOutdated( const QSet< QString > &children );

    void registerWidgetContextGenerator( QgsProcessingWidgetContextGenerator *generator );
 
  signals:

    void rebuildRequired();

    void componentAboutToChange( const QString &text, const QString &id = QString() );

    void componentChanged();

    void selectedItemChanged( QgsModelComponentGraphicItem *selected );

    void runSelected();

    void runFromChild( const QString &childId );

    void showChildAlgorithmOutputs( const QString &childId );

    void showChildAlgorithmLog( const QString &childId );
 
  protected:
    SIP_SKIP virtual QgsModelComponentGraphicItem *createParameterGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelParameter *param ) const;

    SIP_SKIP QgsModelChildAlgorithmGraphicItem *createChildAlgGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelChildAlgorithm *child ) const;

    virtual QgsModelComponentGraphicItem *createOutputGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelOutput *output ) const SIP_FACTORY;

    SIP_SKIP QgsModelComponentGraphicItem *createCommentGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelComment *comment, QgsModelComponentGraphicItem *parentItem ) const;

    SIP_SKIP QgsModelComponentGraphicItem *createGroupBoxGraphicItem( QgsProcessingModelAlgorithm *model, QgsProcessingModelGroupBox *box ) const;
 
  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 );
    void addFeatureCountItemForArrow( QgsModelArrowItem *arrow, const QString &layerId );
 
    Flags mFlags = Flags();
 
    QgsProcessingModelAlgorithm *mModel = nullptr;
 
    QMap<QString, QgsModelComponentGraphicItem *> mParameterItems;
    QMap<QString, QgsModelChildAlgorithmGraphicItem *> mChildAlgorithmItems;
    QMap<QString, QMap<QString, QgsModelComponentGraphicItem *>> mOutputItems;
    QMap<QString, QgsModelComponentGraphicItem *> mGroupBoxItems;
    QgsProcessingModelResult mLastResult;
    QMap<QString, long long> mLastResultCount;
 
    static constexpr int SCENE_COMPONENT_MARGIN = 500;
 
    QgsProcessingWidgetContextGenerator *mWidgetContextGenerator = nullptr;
 
    QgsMessageBar *mMessageBar = nullptr;
};
 
Q_DECLARE_METATYPE( QgsModelGraphicsScene::Flags )
 

 
#endif // QGSMODELCOMPONENTGRAPHICITEM_H