EntityProperties.h

Go to the documentation of this file.

#pragma once
#pragma warning(disable : 4251)
 
#include <string>
#include <map>
 
#include "EntityPropertiesItems.h"
 
#include "OTGui/PropertyGridCfg.h"
 
class EntityBase;
 
namespace ot { class PropertyGroup; };
 
class __declspec(dllexport) EntityProperties
{
public:
    EntityProperties() : m_needsUpdate(false) {};
    EntityProperties(const EntityProperties &other);
    virtual ~EntityProperties();
 
    void merge(EntityProperties& other);
 
    bool createProperty(EntityPropertiesBase *property, const std::string &group, bool addToFront = false);
    bool updateProperty(EntityPropertiesBase *property, const std::string &group);
    bool deleteProperty(const std::string &_name, const std::string& _groupName = "");
    bool propertyExists(const std::string &_name, const std::string& _groupName = "");
 
    EntityPropertiesBase *getProperty(const std::string &_name, const std::string& _groupName = "");
 
    void setNeedsUpdate(void) { m_needsUpdate = true; };
    bool anyPropertyNeedsUpdate(void) const { return m_needsUpdate; };
    void checkWhetherUpdateNecessary(void);
    void forceResetUpdateForAllProperties();
 
    void addToConfiguration(EntityBase *root, bool visibleOnly, ot::PropertyGridCfg& _config);
    void buildFromConfiguration(const ot::PropertyGridCfg& _config, EntityBase* root);
    void buildFromConfiguration(const ot::PropertyGroup* _groupConfig, EntityBase* root);
 
    std::string createJSON(EntityBase* root, bool visibleOnly);
    void buildFromJSON(const std::string& prop, EntityBase* root);
 
    void checkMatchingProperties(EntityProperties &other);
    void readFromProperties(const EntityProperties &other, EntityBase *root);
 
    EntityProperties& operator=(const EntityProperties &other);
 
    void setAllPropertiesReadOnly(void);
    void setAllPropertiesNonProtected(void);
 
    std::list<EntityPropertiesBase*> getListOfAllProperties(void);
    std::list<EntityPropertiesBase *> getListOfPropertiesWhichNeedUpdate(void);
    std::list<EntityPropertiesDouble *> getListOfNumericalProperties(void);
    size_t getNumberOfProperties(void) const { return m_properties.size(); }
 
    std::list<std::string> getListOfPropertiesForGroup(const std::string &group) const;
 
    static std::string createKey(const std::string& _name, const std::string& _group);
    bool isKey(const std::string _accesser) const;
    std::string extractNameFromKey(const std::string& _key) const;
 
private:
    void deleteAllProperties(void);
 
    bool m_needsUpdate;
    std::map<std::string, EntityPropertiesBase *> m_properties;
    std::list<EntityPropertiesBase *> m_propertiesList; // The storage in the list is redundant, but allows to keep the order of the properties
};