GraphicsItem.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Flags.h"
#include "OTCore/CoreTypes.h"
#include "OTGui/Margins.h"
#include "OTGui/GuiTypes.h"
#include "OTGui/GraphicsItemCfg.h"
#include "OTGui/GraphicsConnectionCfg.h"
#include "OTWidgets/GraphicsElement.h"
#include "OTWidgets/OTWidgetsAPIExport.h"
 
// Qt header
#include <QtCore/qpoint.h>
#include <QtWidgets/qgraphicsitem.h>
#include <QtWidgets/qgraphicslayoutitem.h>
 
// std header
#include <list>
#include <string>
 
namespace ot {
 
    class Painter2D;
    class GraphicsItemCfg;
    class GraphicsConnectionItem;
 
    class OT_WIDGETS_API_EXPORT GraphicsItem : public GraphicsElement {
        OT_DECL_NODEFAULT(GraphicsItem)
        OT_DECL_NOCOPY(GraphicsItem)
    public:
 
        // ###############################################################################################################################################
 
        // Types
 
        enum GraphicsItemEvent {
            ItemMoved,
            ItemResized
        };
 
        // ###############################################################################################################################################
 
        // Public Static
 
        static Painter2D* createSelectionBorderPainter(void);
 
        static Painter2D* createHoverBorderPainter(void);
 
        // ###############################################################################################################################################
 
        // Constructor / Destructor
 
        GraphicsItem(GraphicsItemCfg* _configuration);
 
        virtual ~GraphicsItem();
 
        // ###############################################################################################################################################
 
        // Pure virtual functions
 
        virtual void callPaint(QPainter* _painter, const QStyleOptionGraphicsItem* _opt, QWidget* _widget) = 0;
 
        virtual QGraphicsLayoutItem* getQGraphicsLayoutItem(void) = 0;
 
        virtual void prepareGraphicsItemGeometryChange(void) = 0;
 
        virtual QSizeF graphicsItemSizeHint(Qt::SizeHint _hint, const QSizeF& _constrains) const = 0;
 
        // ###############################################################################################################################################
 
        // Virtual functions
 
        virtual bool setupFromConfig(const GraphicsItemCfg* _cfg);
 
        virtual void graphicsItemEventHandler(GraphicsItem* _sender, GraphicsItemEvent _event) {};
 
        virtual void graphicsItemFlagsChanged(const GraphicsItemCfg::GraphicsItemFlags& _flags);
 
        virtual void graphicsItemConfigurationChanged(const GraphicsItemCfg* _config);
 
        virtual ot::GraphicsItem* findItem(const std::string& _itemName);
 
        virtual void removeAllConnections(void);
 
        virtual bool graphicsItemRequiresHover(void) const;
 
        virtual void finalizeGraphicsItem(void) {};
 
        // ###############################################################################################################################################
 
        // Event handler
 
        void handleMousePressEvent(QGraphicsSceneMouseEvent* _event);
 
        bool handleMouseMoveEvent(QGraphicsSceneMouseEvent* _event);
        void handleMouseReleaseEvent(QGraphicsSceneMouseEvent* _event);
        void handleHoverEnterEvent(QGraphicsSceneHoverEvent* _event);
        void handleToolTip(QGraphicsSceneHoverEvent* _event);
        void handleHoverLeaveEvent(QGraphicsSceneHoverEvent* _event);
        
        QSizeF handleGetGraphicsItemSizeHint(Qt::SizeHint _hint, const QSizeF& _sizeHint) const;
 
        QRectF handleGetGraphicsItemBoundingRect(const QRectF& _rect) const;
 
        void handleItemChange(QGraphicsItem::GraphicsItemChange _change, const QVariant& _value);
 
        void handleSetItemGeometry(const QRectF& _geom);
 
        void raiseEvent(ot::GraphicsItem::GraphicsItemEvent _event);
 
        virtual qreal calculateShortestDistanceToPoint(const QPointF& _pt) const override;
 
        QRectF calculatePaintArea(const QSizeF& _innerSize);
 
        // ###############################################################################################################################################
 
        // Getter / Setter
 
        virtual GraphicsScene* getGraphicsScene(void) const override;
 
        GraphicsItem* getRootItem(void);
 
        const GraphicsItem* getRootItem(void) const;
 
        void setConfiguration(GraphicsItemCfg* _config);
 
        const GraphicsItemCfg* const getConfiguration(void) const { return m_config; };
 
        void setGraphicsItemPos(const QPointF& _pos);
 
        void setGraphicsItemPos(const Point2DD& _pos);
 
        const Point2DD& getGraphicsItemPos(void) const;
 
        virtual void setParentGraphicsItem(GraphicsItem* _itm) { m_parent = _itm; };
        GraphicsItem* getParentGraphicsItem(void) const { return m_parent; };
        
        void setGraphicsItemFlag(ot::GraphicsItemCfg::GraphicsItemFlag _flag, bool _active = true);
 
        void setGraphicsItemFlags(ot::GraphicsItemCfg::GraphicsItemFlags _flags);
 
        const GraphicsItemCfg::GraphicsItemFlags& getGraphicsItemFlags(void) const;
 
        void setGraphicsItemUid(const ot::UID& _uid);
        const ot::UID& getGraphicsItemUid(void) const;
 
        virtual void setGraphicsItemName(const std::string& _name);
        const std::string& getGraphicsItemName(void) const;
 
        void setGraphicsItemToolTip(const std::string& _toolTip);
        const std::string& getGraphicsItemToolTip(void) const;
 
        void setAdditionalTriggerDistance(const ot::MarginsD& _distance);
        const ot::MarginsD& getAdditionalTriggerDistance(void) const;
        
        virtual double getMaxAdditionalTriggerDistance(void) const;
        
        void setGraphicsItemMinimumSize(double _width, double _height) { this->setGraphicsItemMinimumSize(QSizeF(_width, _height)); };
        void setGraphicsItemMinimumSize(const QSizeF& _size);
        QSizeF getGraphicsItemMinimumSize(void) const;
    
        void setGraphicsItemMaximumSize(double _width, double _height) { this->setGraphicsItemMaximumSize(QSizeF(_width, _height)); };
        void setGraphicsItemMaximumSize(const QSizeF& _size);
        QSizeF getGraphicsItemMaximumSize(void) const;
 
        void setGraphicsItemSizePolicy(ot::SizePolicy _policy);
        ot::SizePolicy getGraphicsItemSizePolicy(void) const;
 
        void setGraphicsItemAlignment(ot::Alignment _align);
        ot::Alignment getGraphicsItemAlignment(void) const;
 
        void setGraphicsItemMargins(const ot::MarginsD& _margins);
        const ot::MarginsD& getGraphicsItemMargins(void) const;
 
        void setConnectionDirection(ot::ConnectionDirection _direction);
        ot::ConnectionDirection getConnectionDirection(void) const;
 
        void setStringMap(const std::map<std::string, std::string>& _map);
        const std::map<std::string, std::string>& getStringMap(void) const;
 
        void setGraphicsItemTransform(const Transform& _transform);
        const Transform& getGraphicsItemTransform(void) const;
 
        void setForwardSizeChanges(bool _forward) { m_forwardSizeChanges = _forward; };
        bool getForwardSizeChanges(void) const { return m_forwardSizeChanges; };
 
        void storeConnection(GraphicsConnectionItem* _connection);
 
        void forgetConnection(GraphicsConnectionItem* _connection);
 
        void addGraphicsItemEventHandler(ot::GraphicsItem* _handler);
        void removeGraphicsItemEventHandler(ot::GraphicsItem* _handler);
 
        QSizeF applyGraphicsItemMargins(const QSizeF& _size) const;
        QSizeF removeGraphicsItemMargins(const QSizeF& _size) const;
 
        virtual void setGraphicsItemRequestedSize(const QSizeF& _size);
        const QSizeF& graphicsItemRequestedSize(void) const { return m_requestedSize; };
 
        std::list<ot::GraphicsConnectionCfg> getConnectionCfgs();
 
        void setGraphicsItemSelected(bool _selected);
        bool getGraphicsItemSelected(void) const;
 
        void setBlockFlagNotifications(bool _block) { m_blockFlagNotifications = _block; };
 
        bool getBlockFlagNotifications(void) const { return m_blockFlagNotifications; };
 
        void setBlockConfigurationNotifications(bool _block) { m_blockConfigurationNotifications = _block; };
        
        bool getBlockConfigurationNotifications(void) const { return m_blockConfigurationNotifications; };
 
        void setCurrentPosAsMoveStart(void);
 
        void notifyMoveIfRequired(void);
 
        void parentItemTransformChanged(const QTransform& _parentTransform);
 
        QRectF getTriggerBoundingRect(void) const;
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Protected notifier
 
    protected:
        virtual void graphicsElementStateChanged(const GraphicsElementStateFlags& _state) override;
 
        template <class T> T* getItemConfiguration(void);
 
        template <class T> const T* getItemConfiguration(void) const;
 
        virtual void applyGraphicsItemTransform(void);
 
        virtual void notifyChildsAboutTransformChange(const QTransform& _newTransform) {};
 
    private:
        ConnectionDirection calculateOutwardsConnectionDirection(void) const;
 
        GraphicsItemCfg* m_config; 
        
        QPointF m_moveStartPt; 
        GraphicsItem* m_parent; 
        
        QSizeF m_requestedSize; 
 
        bool m_forwardSizeChanges;
 
        bool m_blockFlagNotifications;
        bool m_blockConfigurationNotifications;
        
        std::list<GraphicsItem*> m_eventHandler;
        std::list<GraphicsConnectionItem*> m_connections;
    };
 
}
 
#include "OTWidgets/GraphicsItem.hpp"