GraphicsFlowItemBuilder.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/OTClassHelper.h"
#include "OTGui/OTGuiAPIExport.h"
#include "OTGui/GraphicsItemCfg.h"
#include "OTGui/GraphicsTriangleItemCfg.h"
#include "OTGui/Margins.h"
 
namespace ot {
 
    class GraphicsGridLayoutItemCfg;
 
    class Painter2D;
 
    class OT_GUI_API_EXPORT GraphicsFlowItemConnector {
    public:
        enum ConnectorFigure {
            Square,
            TriangleRight,
            TriangleLeft,
            TriangleUp,
            TriangleDown,
            KiteRight,
            KiteLeft,
            KiteUp,
            KiteDown,
            IceConeRight,
            IceConeLeft,
            IceConeUp,
            IceConeDown,
            Circle
        };
 
        GraphicsFlowItemConnector();
        GraphicsFlowItemConnector(const GraphicsFlowItemConnector& _other);
        virtual ~GraphicsFlowItemConnector();
        GraphicsFlowItemConnector& operator = (const GraphicsFlowItemConnector& _other);
 
        void setName(const std::string& _name) { m_name = _name; };
        const std::string& name(void) const { return m_name; };
 
        void setText(const std::string& _text) { m_text = _text; };
        const std::string& text(void) const { return m_text; };
 
        void setToolTip(const std::string& _toolTip) { m_toolTip = _toolTip; };
        const std::string& toolTip(void) const { return m_toolTip; };
 
        void setFont(const ot::Font& _font) { m_font = _font; };
        const ot::Font& font(void) const { return m_font; };
 
        void setTextColor(const ot::Color& _color) { m_textColor = _color; };
        const ot::Color& textColor(void) const { return m_textColor; };
 
        void setCustomPrimaryPainter(ot::Painter2D* _painter);
        const ot::Painter2D* getCustomPrimaryPainter(void) const { return m_customPrimaryPainter; };
 
        void setCustomSecondaryPainter(ot::Painter2D* _painter);
        const ot::Painter2D* getCustomSecondaryPainter(void) const { return m_customSecondaryPainter; };
 
        void setFigure(GraphicsFlowItemConnector::ConnectorFigure _figure) { m_figure = _figure; };
        GraphicsFlowItemConnector::ConnectorFigure figure(void) const { return m_figure; };
 
        void addToGrid(int _row, GraphicsGridLayoutItemCfg* _gridLayout, bool _isLeft);
 
    private:
        Painter2D* createPrimaryPainter(void) const;
        Painter2D* createSecondaryPainter(void) const;
 
        ot::GraphicsItemCfg* createConnectorItem(void);
        ot::GraphicsItemCfg* createSquareItem(void);
        ot::GraphicsItemCfg* createCircleItem(void);
        ot::GraphicsItemCfg* createTriangleItem(GraphicsTriangleItemCfg::TriangleDirection _direction, GraphicsTriangleItemCfg::TriangleShape _shape);
 
        std::string m_name;
        std::string m_text;
        std::string m_toolTip;
        ConnectorFigure m_figure;
        ot::Color m_textColor;
        ot::Font m_font;
        ot::Painter2D* m_customPrimaryPainter;
        ot::Painter2D* m_customSecondaryPainter;
    };
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    class OT_GUI_API_EXPORTONLY GraphicsFlowItemBuilder {
        OT_DECL_NOCOPY(GraphicsFlowItemBuilder)
    public:
        enum BackgroundImageInsertMode {
            OnLayout,
            OnStack
        };
 
        ot::GraphicsItemCfg* createGraphicsItem(void) const;
 
        GraphicsFlowItemBuilder();
        virtual ~GraphicsFlowItemBuilder();
 
        void setName(const std::string& _name) { m_name = _name; };
 
        const std::string& name(void) const { return m_name; };
 
        void setTitle(const std::string& _title) { m_title = _title; };
 
        const std::string& title(void) const { return m_title; };
 
        void setToolTip(const std::string& _toolTip) { m_toolTip = _toolTip; };
 
        const std::string& toolTip(void) const { return m_toolTip; };
 
        void addLeft(const std::string& _name, const std::string& _title, GraphicsFlowItemConnector::ConnectorFigure _figure);
 
        void addLeft(const std::string& _name, const std::string& _title, GraphicsFlowItemConnector::ConnectorFigure _figure, ot::DefaultColor _color);
 
        void addLeft(const std::string& _name, const std::string& _title, GraphicsFlowItemConnector::ConnectorFigure _figure, const ot::Color& _color);
 
        void addLeft(const GraphicsFlowItemConnector& _left);
 
        void addRight(const std::string& _name, const std::string& _title, GraphicsFlowItemConnector::ConnectorFigure _figure);
 
        void addRight(const std::string& _name, const std::string& _title, GraphicsFlowItemConnector::ConnectorFigure _figure, ot::DefaultColor _color);
 
        void addRight(const std::string& _name, const std::string& _title, GraphicsFlowItemConnector::ConnectorFigure _figure, const ot::Color& _color);
 
        void addRight(const GraphicsFlowItemConnector& _right);
 
        void setTitleBackgroundPainter(ot::Painter2D* _painter);
 
        void setTitleBackgroundColor(const ot::Color& _color);
 
        void setTitleBackgroundGradientColor(const ot::Color& _color);
 
        inline void setTitleBackgroundColor(int _r, int _g, int _b, int _a = 255) { this->setTitleBackgroundColor(ot::Color(_r, _g, _b, _a)); };
 
        void setTitleForegroundPainter(ot::Painter2D* _painter);
 
        void setTitleForegroundColor(const ot::Color& _color);
 
        void setDefaultTitleForegroundGradient(void);
 
        void setDefaultConnectorStyle(const GraphicsFlowItemConnector& _config) { m_defaultConnectorStyle = _config; };
        const GraphicsFlowItemConnector& defaultConnectorStyle(void) const { return m_defaultConnectorStyle; };
 
        void setBackgroundImagePath(const std::string& _path) { m_backgroundImagePath = _path; };
        void setBackgroundImageAlignment(ot::Alignment _align) { m_backgroundImageAlignment = _align; };
        void setBackgroundImageMargins(const ot::MarginsD& _margins) { m_backgroundImageMargins = _margins; };
        void setBackgroundImageInsertMode(BackgroundImageInsertMode _mode) { m_backgroundImageInsertMode = _mode; };
        void setBackgroundImageMaintainAspectRatio(bool _active) { m_backgroundImageMaintainAspectRatio = _active; };
 
        void setLeftTitleCornerImagePath(const std::string& _path) { m_leftTitleImagePath = _path; };
 
        void setRightTitleCornerImagePath(const std::string& _path) { m_rightTitleImagePath = _path; };
 
    private:
        std::string m_name;
        std::string m_title;
        std::string m_toolTip;
 
        ot::Painter2D* m_titleBackgroundPainter;
        ot::Painter2D* m_titleForegroundPainter;
 
        std::string m_leftTitleImagePath;
        std::string m_rightTitleImagePath;
 
        std::string m_backgroundImagePath;
        ot::Alignment m_backgroundImageAlignment;
        ot::MarginsD m_backgroundImageMargins;
        BackgroundImageInsertMode m_backgroundImageInsertMode;
        bool m_backgroundImageMaintainAspectRatio;
 
        GraphicsFlowItemConnector m_defaultConnectorStyle;
 
        std::list<GraphicsFlowItemConnector> m_left;
        std::list<GraphicsFlowItemConnector> m_right;
    };
 
}