GraphicsItemCfg.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Size2D.h"
#include "OTCore/Point2D.h"
#include "OTCore/Flags.h"
#include "OTCore/Serializable.h"
#include "OTGui/Font.h"
#include "OTGui/Margins.h"
#include "OTGui/GuiTypes.h"
#include "OTGui/Transform.h"
#include "OTGui/OTGuiAPIExport.h"
#include "OTCore/CoreTypes.h"
 
// std header
#include <map>
#include <string>
 
#pragma warning(disable:4251)
 
#define OT_JSON_MEMBER_GraphicsItemCfgType "GIType"
 
namespace ot {
 
    class OT_GUI_API_EXPORT GraphicsItemCfg : public ot::Serializable {
    public:
 
        enum GraphicsItemFlag {
            NoFlags                    = 0x0000, 
            ItemIsMoveable             = 0x0001, 
            ItemIsSelectable           = 0x0002,
            ItemIsConnectable          = 0x0004, 
 
            ItemSnapsToGridTopLeft     = 0x0010, 
            ItemSnapsToGridCenter      = 0x0020, 
 
            ItemForwardsTooltip        = 0x0100,
 
            ItemUserTransformEnabled   = 0x0200,
 
            ItemIgnoresParentTransform = 0x0400,
 
            ItemHandlesState           = 0x1000,
 
            ItemForwardsState          = 0x2000
        };
        typedef Flags<GraphicsItemFlag> GraphicsItemFlags; 
 
        GraphicsItemCfg();
        virtual ~GraphicsItemCfg();
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Pure virtual methods
 
        virtual std::string getFactoryKey(void) const = 0;
 
        virtual GraphicsItemCfg* createCopy(void) const = 0;
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Base class methods
 
        virtual void addToJsonObject(JsonValue& _object, JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ConstJsonObject& _object) override;
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Setter / Getter
 
        void setName(const std::string& _name) { m_name = _name; };
 
        const std::string& getName(void) const { return m_name; };
 
        void setTitle(const std::string& _title) { m_title = _title; };
 
        const std::string& getTitle(void) const { return m_title; };
 
        void setToolTip(const std::string& _toolTip) { m_tooltip = _toolTip; };
 
        const std::string& getToolTip(void) const { return m_tooltip; };
 
        void setPosition(double _x, double _y) { this->setPosition(Point2DD(_x, _y)); };
 
        void setPosition(const Point2DD& _pos) { m_pos = _pos; };
 
        const Point2DD& getPosition(void) const { return m_pos; };
 
        void setAdditionalTriggerDistance(double _d) { this->setAdditionalTriggerDistance(MarginsD(_d, _d, _d, _d)); };
 
        void setAdditionalTriggerDistance(double _left, double _top, double _right, double _bottom) { this->setAdditionalTriggerDistance(MarginsD(_left, _top, _right, _bottom)); };
 
        void setAdditionalTriggerDistance(const MarginsD& _d) { m_additionalTriggerDistance = _d; };
 
        const MarginsD& getAdditionalTriggerDistance(void) const { return m_additionalTriggerDistance; };
 
        void setMinimumSize(double _width, double _height) { this->setMinimumSize(Size2DD(_width, _height)); };
 
        void setMinimumSize(const Size2DD& _size) { m_minSize = _size; };
 
        const Size2DD& getMinimumSize(void) const { return m_minSize; };
 
        void setMaximumSize(double _width, double _height) { this->setMaximumSize(Size2DD(_width, _height)); };
 
        void setMaximumSize(const Size2DD& _size) { m_maxSize = _size; };
 
        const Size2DD& getMaximumSize(void) const { return m_maxSize; };
 
        void setFixedSize(double _width, double _height) { this->setFixedSize(Size2DD(_width, _height)); };
 
        void setFixedSize(const Size2DD& _size);
 
        void setMargins(double _left, double _top, double _right, double _bottom) { this->setMargins(ot::MarginsD(_left, _top, _right, _bottom)); };
 
        void setMargins(const MarginsD& _margins) { m_margins = _margins; };
 
        const MarginsD& getMargins(void) const { return m_margins; };
 
        void setGraphicsItemFlag(GraphicsItemFlag _flag, bool _active = true) { m_flags.setFlag(_flag, _active); };
        void setGraphicsItemFlags(const GraphicsItemFlags& _flags) { m_flags = _flags; };
        const GraphicsItemFlags& getGraphicsItemFlags(void) const { return m_flags; };
 
        void setAlignment(Alignment _align) { m_alignment = _align; };
 
        Alignment getAlignment(void) const { return m_alignment; };
 
        void setUid(const UID& _uid) { m_uid = _uid; };
 
        const ot::UID& getUid(void) const { return m_uid; };
 
        void setSizePolicy(SizePolicy _policy) { m_sizePolicy = _policy; };
 
        SizePolicy getSizePolicy(void) const { return m_sizePolicy; };
 
        void setConnectionDirection(ConnectionDirection _direction) { m_connectionDirection = _direction; };
 
        ConnectionDirection getConnectionDirection(void) const { return m_connectionDirection; };
 
        void addStringMapEntry(const std::string& _key, const std::string& _value) { m_stringMap.insert_or_assign(_key, _value); };
 
        void setStringMap(const std::map<std::string, std::string>& _map) { m_stringMap = _map; };
 
        const std::map<std::string, std::string>& getStringMap(void) const { return m_stringMap; };
 
        std::string getStringForKey(const std::string& _key) const;
 
        void setTransform(const Transform& _transform) { m_transform = _transform; };
 
        const Transform& getTransform(void) const { return m_transform; };
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Helper
 
        virtual void copyConfigDataToItem(GraphicsItemCfg* _target) const;
 
    private:
        std::string m_name; 
        std::string m_title; 
        ot::UID m_uid; 
        std::string m_tooltip; 
        Point2DD m_pos; 
        MarginsD m_additionalTriggerDistance; 
 
        Size2DD m_minSize; 
        Size2DD m_maxSize; 
 
        MarginsD m_margins; 
        GraphicsItemFlags m_flags; 
        ot::Alignment m_alignment; 
        ot::SizePolicy m_sizePolicy; 
        ConnectionDirection m_connectionDirection; 
 
        Transform m_transform; 
 
        std::map<std::string, std::string> m_stringMap; 
    };
 
}
 
OT_ADD_FLAG_FUNCTIONS(ot::GraphicsItemCfg::GraphicsItemFlag)