graphics_scene.h

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "gui/graph_widget/items/utility_items/node_drag_shadow.h"
#include "gui/graph_widget/shaders/graph_shader.h"
#include "gui/gui_globals.h"
#include "gui/module_model/module_item.h"
#include "gui/graph_widget/graphics_qss_adapter.h"
#include "hal_core/defines.h"
#include "hal_core/netlist/gate.h"
#include "hal_core/netlist/module.h"
 
#include <QGraphicsScene>
#include <QPair>
#include <QVector>
 
namespace hal
{
    class GraphicsGate;
    class GraphicsItem;
    class GraphicsModule;
    class GraphicsNet;
    class DragController;
 
    class GraphicsScene : public QGraphicsScene
    {
        Q_OBJECT
 
    public:
        enum GridType
        {
            None,
            Dots,
            Lines
        };
        Q_ENUM(GridType);
 
        static void setLod(const qreal& lod);
 
        static void setGridEnabled(const bool& value);
 
        static void setGridClustersEnabled(const bool& value);
 
        static void setGridType(const GridType& gridType);
 
        static QPointF snapToGrid(const QPointF& pos) Q_DECL_DEPRECATED;
 
        GraphicsScene(QObject* parent = nullptr);
 
        ~GraphicsScene();
 
        QPointF dropTarget();
 
        void addGraphItem(GraphicsItem* item);
 
        void removeGraphItem(GraphicsItem* item);
 
        void deleteAllItems();
 
        void connectAll();
 
        void disconnectAll();
 
        void updateVisuals(const GraphShader::Shading& s);
 
        void moveNetsToBackground();
 
        const GraphicsGate* getGateItem(const u32 id) const;
 
        const GraphicsNet* getNetItem(const u32 id) const;
 
        const GraphicsModule* getModuleItem(const u32 id) const;
 
        void setMousePressed(bool isPressed);
 
#ifdef GUI_DEBUG_GRID
        void debugSetLayouterGrid(const QVector<qreal>& debug_x_lines, const QVector<qreal>& debug_y_lines, qreal debug_default_height, qreal debug_default_width);
        void setDebugGridEnabled(bool enabled);
        bool debugGridEnabled();
#endif
 
    public Q_SLOTS:
        void handleInternSelectionChanged();
 
        void handleExternSelectionChanged(void* sender);
 
        void handleExternSubfocusChanged(void* sender);
 
        void handleHighlight(const QVector<const ModuleItem*>& highlightItems);
 
        void handleGroupingAssignModule(Grouping* grp, u32 id);
 
        void handleGroupingAssignGate(Grouping* grp, u32 id);
 
        void handleGroupingAssignNet(Grouping* grp, u32 id);
 
        void handleGroupingColorChanged(Grouping* grp);
 
        void updateAllItems();
 
        void setDragController(DragController* dc);
 
    protected:
        void mousePressEvent(QGraphicsSceneMouseEvent* event) override;
 
    private:
        static qreal sLod;
 
        static const qreal sGridFadeStart;
        static const qreal sGridFadeEnd;
 
        static bool sGridEnabled;
        static bool sGridClustersEnabled;
        static GraphicsScene::GridType sGridType;
 
        //       using QGraphicsScene::addItem;
        //       using QGraphicsScene::removeItem;
        using QGraphicsScene::clear;
 
        void drawBackground(QPainter* painter, const QRectF& rect) override;
 
        QVector<GraphicsModule*> mModuleItems;
        QVector<GraphicsGate*> mGateItems;
        QVector<GraphicsNet*> mNetItems;
 
#ifdef GUI_DEBUG_GRID
        void debugDrawLayouterGrid(QPainter* painter, const int x_from, const int x_to, const int y_from, const int y_to);
        QVector<qreal> mDebugXLines;
        QVector<qreal> mDebugYLines;
        qreal mDebugDefaultWidth;
        qreal mDebugDefaultHeight;
        bool mDebugGridEnable;
        DragController* mDragController;
        enum RubberBandSelectionStatus
        {
            NotPressed,
            BeginPressed,
            SelectionChanged,
            EndPressed
        } mSelectionStatus;
#endif
    };
}    // namespace hal