CircuitDiagram.h

Go to the documentation of this file.

// This file is part of DynExp.
 
#pragma once
 
#include <QWidget>
#include "DynExpDefinitions.h"
#include "Object.h"
 
namespace Ui
{
    class CircuitDiagram;
}
 
namespace DynExp
{
    class DynExpCore;
}
 
class CircuitDiagram : public QDialog
{
    Q_OBJECT
 
    class CircuitDiagramItem;
 
    using NodeMapType = std::unordered_map<DynExp::ItemIDType, CircuitDiagramItem>;
    using NodeListType = std::vector<typename NodeMapType::mapped_type*>;
 
    static constexpr double ZoomFactor = 1.6;
 
    struct GraphType
    {
        NodeListType HardwareAdapters;
        NodeListType Instruments;
        NodeListType Modules;
 
        double EvaluateEnergy() const;
        double DistanceTo(const GraphType& Other) const;
 
        bool operator==(const GraphType& Other) const;
        bool operator!=(const GraphType& Other) const { return !(*this == Other); }
    };
 
    class CircuitDiagramItem
    {
    public:
        CircuitDiagramItem() : TreeWidgetItem(nullptr), Empty(true) {}
        CircuitDiagramItem(QTreeWidgetItem* TreeWidgetItem) : TreeWidgetItem(TreeWidgetItem), Empty(false) {}
 
        void InsertLinks(const DynExp::ParamsBase::ObjectLinkParamsType& ObjectLinkParams, const DynExp::DynExpCore& DynExpCore,
            NodeMapType* HardwareAdapterNodes, NodeMapType* InstrumentNodes);
 
        size_t GetNumLinkedItems();
 
        QTreeWidgetItem* TreeWidgetItem;
 
        QString NetworkAddress = nullptr;
 
        QPointF TopLeftPos;
 
        qreal ParamSectionHeight{};
        qreal ItemHeight{};
 
        struct LinkedParamType
        {
            struct LinkedItemType
            {
                LinkedItemType() noexcept : Item(nullptr), SocketIndex(0) {}
                LinkedItemType(CircuitDiagramItem* Item) noexcept : Item(Item), SocketIndex(0) {}
 
                CircuitDiagramItem* Item;
                size_t SocketIndex;
            };
 
            std::string_view LinkTitle;
            std::vector<LinkedItemType> LinkedItems;    // May contain LinkedItemType with Item = nullptr.
            size_t ParamGraphicsItemIndex{};
        };
 
        std::vector<LinkedParamType> LinkedParams;
 
        const bool Empty;
 
        // Item's displayed parts
        struct ParamGraphicsItemsType
        {
            QGraphicsPathItem* Frame = nullptr;
            QGraphicsSimpleTextItem* Label = nullptr;
            std::vector<QGraphicsEllipseItem*> Sockets;
            std::vector<QGraphicsPathItem*> Links;
        };
 
        QGraphicsPathItem* StateFrame = nullptr;
        QIcon StateIcon;
        QGraphicsPixmapItem* StatePixmap = nullptr;
        QGraphicsSimpleTextItem* StateLabel = nullptr;
        QGraphicsPathItem* ItemFrame = nullptr;
        QGraphicsSimpleTextItem* ItemLabel = nullptr;
        QIcon ItemIcon;
        QGraphicsPixmapItem* ItemPixmap = nullptr;
        QGraphicsEllipseItem* OutputSocket = nullptr;
        std::vector<ParamGraphicsItemsType> ParamGraphicsItems;
        QIcon NetworkIcon;
        QGraphicsPixmapItem* NetworkPixmap = nullptr;
        QGraphicsPathItem* NetworkLink = nullptr;
    };
 
public:
    CircuitDiagram(QWidget *parent);
    ~CircuitDiagram();
 
    QTreeWidgetItem* GetSelectedEntry();
 
    bool Redraw(const DynExp::DynExpCore& DynExpCore);
 
    bool UpdateStates(const DynExp::DynExpCore& DynExpCore);
 
protected:
    virtual void mouseDoubleClickEvent(QMouseEvent* Event) override;
    virtual void wheelEvent(QWheelEvent* Event) override;
 
private:
    // Constants for rendering the circuit diagram
    static constexpr int NodeVSep = 40;
    static constexpr int NodeHSep = 220;
    static constexpr int TreeWidgetParentTypeColumn = 0;
    static constexpr int TreeWidgetItemNameColumn = 0;
    static constexpr int TreeWidgetItemTypeColumn = 1;
    static constexpr int TreeWidgetItemStateColumn = 2;
    static constexpr int OuterPenLineWidth = 4;
    static constexpr int InnerPenLineWidth = 1;
    static constexpr int CornerRoundingRadius = 8;
    static constexpr int InnerWidth = 140;
    static constexpr int InnerStartHeight = 50;
    static constexpr int InnerMargin = 6;
    static constexpr int InnerMarginTop = 10;
    static constexpr int InnerMarginBottom = 20;
    static constexpr int StateIconSize = 16;
    static constexpr int TypeIconSize = 24;
    static constexpr int IconMargin = 4;
    static constexpr int AdditionalHeightPerParam = 12;
    static constexpr int ParamSep = 6;
    static constexpr int SocketDiameter = 6;
    static constexpr int SocketPenLineWidth = 2;
    static constexpr int NetworkIconDistance = 30;
    static const QColor SocketOuterColor;
    static const QColor SocketInnerColor;
 
    static QLinearGradient GetGrayLinearGradient();
 
    // Helper functions
    void Clear();
    void BuildTree(const DynExp::DynExpCore& DynExpCore);
    void ArrangeTree();
    void RefineBySimulatedAnnealing(GraphType& Graph);
    void Render();
    void RenderItem(CircuitDiagramItem& Item, bool DrawOutputSocket);
    void RenderLinks(CircuitDiagramItem& Item);
    void UpdateItem(CircuitDiagramItem& Item);
    int TransformIconSize(int Size) const;
    void RescaleIcons();
 
    // Zoom functions
    void ZoomIn();
    void ZoomOut();
    void ZoomReset();
 
    // Displayed items
    NodeMapType HardwareAdapterNodes;
    NodeMapType InstrumentNodes;
    NodeMapType ModuleNodes;
 
    // UI
    std::unique_ptr<Ui::CircuitDiagram> ui;
    std::unique_ptr<QGraphicsScene> Scene;
    QMenu* ContextMenu;
 
    // Item currently selected by a double-click
    bool SelectionChanged;
    QTreeWidgetItem* SelectedTreeWidgetItem;
 
private slots:
    void OnContextMenuRequested(QPoint Position);
    void OnZoomIn();
    void OnZoomOut();
    void OnZoomReset();
    void OnSaveDiagram();
};