GraphicsPackage.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Serializable.h"
#include "OTGui/OTGuiAPIExport.h"
#include "OTGui/GraphicsConnectionCfg.h"
 
// std header
#include <list>
 
namespace ot {
 
    class GraphicsItemCfg;
    class GraphicsPickerCollectionCfg;
    
    class OT_GUI_API_EXPORT GraphicsPickerCollectionPackage : public ot::Serializable {
        OT_DECL_NOCOPY(GraphicsPickerCollectionPackage)
    public:
        GraphicsPickerCollectionPackage();
        virtual ~GraphicsPickerCollectionPackage();
 
        virtual void addToJsonObject(JsonValue& _object, JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ConstJsonObject& _object) override;
 
        void addCollection(GraphicsPickerCollectionCfg* _collection);
        const std::list<GraphicsPickerCollectionCfg*>& collections(void) const { return m_collections; };
 
    private:
        void memFree(void);
 
        std::list<GraphicsPickerCollectionCfg*> m_collections;
    };
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    class OT_GUI_API_EXPORT GraphicsNewEditorPackage : public ot::GraphicsPickerCollectionPackage {
    public:
        GraphicsNewEditorPackage(const std::string& _editorName = std::string(), const std::string& _editorTitle = std::string());
        virtual ~GraphicsNewEditorPackage();
 
        virtual void addToJsonObject(JsonValue& _object, JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ConstJsonObject& _object) override;
 
        const std::string& name(void) const { return m_name; };
        const std::string& title(void) const { return m_title; };
 
    private:
        std::string m_name;
        std::string m_title;
 
        GraphicsNewEditorPackage(const GraphicsNewEditorPackage&) = delete;
        GraphicsNewEditorPackage& operator = (const GraphicsNewEditorPackage&) = delete;
    };
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    class OT_GUI_API_EXPORT GraphicsScenePackage : public ot::Serializable {
    public:
        GraphicsScenePackage(const std::string& _editorName = std::string());
        virtual ~GraphicsScenePackage();
 
        virtual void addToJsonObject(JsonValue& _object, JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ConstJsonObject& _object) override;
        
        void addItem(GraphicsItemCfg* _item);
        const std::list<GraphicsItemCfg*>& items(void) const { return m_items; };
 
        void setName(const std::string& _name) { m_name = _name; };
        const std::string& name(void) const { return m_name; };
 
    private:
        void memFree(void);
 
        std::string m_name;
        std::list<ot::GraphicsItemCfg*> m_items;
 
        GraphicsScenePackage(const GraphicsScenePackage&) = delete;
        GraphicsScenePackage& operator = (const GraphicsScenePackage&) = delete;
    };
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    class OT_GUI_API_EXPORT GraphicsConnectionPackage : public ot::Serializable {
    public:
        GraphicsConnectionPackage(const std::string& _editorName = std::string());
        virtual ~GraphicsConnectionPackage();
 
        virtual void addToJsonObject(JsonValue& _object, JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ConstJsonObject& _object) override;
 
        void setName(const std::string& _name) { m_name = _name; };
        const std::string& name(void) const { return m_name; };
 
        void addConnection(const ot::UID& _fromUid, const std::string& _fromConnectable, const ot::UID& _toUid, const std::string& _toConnectable);
        void addConnection(const GraphicsConnectionCfg& _info) { m_connections.push_back(_info); };
        const std::list<GraphicsConnectionCfg>& connections(void) const { return m_connections; };
 
    private:
        std::string m_name;
        std::list<GraphicsConnectionCfg> m_connections;
 
        GraphicsConnectionPackage(const GraphicsConnectionPackage&) = delete;
        GraphicsConnectionPackage& operator = (const GraphicsConnectionPackage&) = delete;
    };
 
}