paysages3d/src/definition/BaseDefinition.h

#ifndef BASEDEFINITION_H
#define BASEDEFINITION_H

#include "definition_global.h"

namespace paysages {
namespace definition {

/**
 * @brief Base class for all definition containers
 */
class DEFINITIONSHARED_EXPORT BaseDefinition
{
public:
    BaseDefinition(BaseDefinition* parent, const std::string &name);
    virtual ~BaseDefinition();

    virtual void save(PackStream* stream) const;
    virtual void load(PackStream* stream);

    virtual void copy(BaseDefinition* destination) const;
    virtual void validate();

    inline const std::string &getName() const {return name;}
    virtual void setName(const std::string &name);

    virtual Scenery* getScenery();

    inline const BaseDefinition* getParent() const {return parent;}
    inline const BaseDefinition* getRoot() const {return root;}
    inline int getChildrenCount() const {return children.size();}

    /**
     * Return a string representation of the tree (mainly for debugging purposes).
     */
    virtual std::string toString(int indent = 0) const;

protected:
    void addChild(BaseDefinition* child);
    void removeChild(BaseDefinition* child);

private:
    BaseDefinition* parent;
    BaseDefinition* root;
    std::string name;
    std::vector<BaseDefinition*> children;
};

}
}

#endif // BASEDEFINITION_H