IAttributes.hpp

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in duckcpp/duckcpp.hpp
 
#ifndef DCPP_I_ATTRIBUTES_HPP_INCLUDED
#define DCPP_I_ATTRIBUTES_HPP_INCLUDED
 
#include <duckcpp/core/engine/IReferenceCounted.hpp>
#include <duckcpp/core/engine/SColor.hpp>
#include <duckcpp/core/engine/vector3d.hpp>
#include <duckcpp/core/engine/vector2d.hpp>
#include <duckcpp/core/engine/line2d.hpp>
#include <duckcpp/core/engine/line3d.hpp>
#include <duckcpp/core/engine/triangle3d.hpp>
#include <duckcpp/core/engine/position2d.hpp>
#include <duckcpp/core/engine/rect.hpp>
#include <duckcpp/core/engine/dimension2d.hpp>
#include <duckcpp/core/engine/matrix4.hpp>
#include <duckcpp/core/engine/quaternion.hpp>
#include <duckcpp/core/engine/plane3d.hpp>
#include <duckcpp/core/engine/triangle3d.hpp>
#include <duckcpp/core/engine/line2d.hpp>
#include <duckcpp/core/engine/line3d.hpp>
#include <duckcpp/core/engine/irrString.hpp>
#include <duckcpp/core/engine/irrArray.hpp>
#include <duckcpp/core/engine/IXMLReader.hpp>
#include <duckcpp/core/engine/IXMLWriter.hpp>
#include <duckcpp/core/engine/EAttributes.hpp>
#include <duckcpp/core/engine/path.hpp>
 
namespace dcpp
{
namespace video
{
    class ITexture;
} // end namespace video
namespace io
{
 
class IAttributes : public virtual IReferenceCounted
{
public:
 
    virtual dcpp::uint32_kt getAttributeCount() const = 0;
 
    virtual const dcpp::char_kt* getAttributeName(dcpp::int32_kt index) const = 0;
 
    virtual E_ATTRIBUTE_TYPE getAttributeType(const dcpp::char_kt* attributeName) const = 0;
 
    virtual E_ATTRIBUTE_TYPE getAttributeType(dcpp::int32_kt index) const = 0;
 
    virtual const wchar_t* getAttributeTypeString(const dcpp::char_kt* attributeName, const wchar_t* defaultNotFound = L"unknown") const = 0;
 
    virtual const wchar_t* getAttributeTypeString(dcpp::int32_kt index, const wchar_t* defaultNotFound = L"unknown") const = 0;
 
    virtual bool existsAttribute(const dcpp::char_kt* attributeName) const = 0;
 
    virtual dcpp::int32_kt findAttribute(const dcpp::char_kt* attributeName) const = 0;
 
    virtual void clear() = 0;
 
    virtual bool read(dcpp::io::IXMLReader* reader, bool readCurrentElementOnly=false, const wchar_t* elementName=0) = 0;
 
    virtual bool write(dcpp::io::IXMLWriter* writer, bool writeXMLHeader=false, const wchar_t* elementName=0) = 0;
 
 
    /*
 
        Integer Attribute
 
    */
 
    virtual void addInt(const dcpp::char_kt* attributeName, dcpp::int32_kt value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, dcpp::int32_kt value) = 0;
 
    virtual dcpp::int32_kt getAttributeAsInt(const dcpp::char_kt* attributeName, dcpp::int32_kt defaultNotFound=0) const = 0;
 
    virtual dcpp::int32_kt getAttributeAsInt(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, dcpp::int32_kt value) = 0;
 
    /*
 
        Float Attribute
 
    */
 
    virtual void addFloat(const dcpp::char_kt* attributeName, dcpp::float32_kt value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, dcpp::float32_kt value) = 0;
 
    virtual dcpp::float32_kt getAttributeAsFloat(const dcpp::char_kt* attributeName, dcpp::float32_kt defaultNotFound=0.f) const = 0;
 
    virtual dcpp::float32_kt getAttributeAsFloat(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, dcpp::float32_kt value) = 0;
 
    /*
 
        String Attribute
 
    */
 
    virtual void addString(const dcpp::char_kt* attributeName, const dcpp::char_kt* value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::char_kt* value) = 0;
 
    virtual dcpp::nub::string getAttributeAsString(const dcpp::char_kt* attributeName, const dcpp::nub::string& defaultNotFound=dcpp::nub::string()) const = 0;
 
    virtual void getAttributeAsString(const dcpp::char_kt* attributeName, dcpp::char_kt* target) const = 0;
 
    virtual dcpp::nub::string getAttributeAsString(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::char_kt* value) = 0;
 
    // wide strings
 
    virtual void addString(const dcpp::char_kt* attributeName, const wchar_t* value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const wchar_t* value) = 0;
 
    virtual dcpp::nub::wstring getAttributeAsWstring(const dcpp::char_kt* attributeName, const dcpp::nub::wstring& defaultNotFound = dcpp::nub::wstring()) const = 0;
 
    virtual void getAttributeAsWstring(const dcpp::char_kt* attributeName, wchar_t* target) const = 0;
 
    virtual dcpp::nub::wstring getAttributeAsWstring(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const wchar_t* value) = 0;
 
    /*
 
        Binary Data Attribute
 
    */
 
    virtual void addBinary(const dcpp::char_kt* attributeName, void* data, dcpp::int32_kt dataSizeInBytes) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, void* data, dcpp::int32_kt dataSizeInBytes ) = 0;
 
 
    virtual void getAttributeAsBinaryData(const dcpp::char_kt* attributeName, void* outData, dcpp::int32_kt maxSizeInBytes) const = 0;
 
 
    virtual void getAttributeAsBinaryData(dcpp::int32_kt index, void* outData, dcpp::int32_kt maxSizeInBytes) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, void* data, dcpp::int32_kt dataSizeInBytes ) = 0;
 
 
    /*
        Array Attribute
    */
 
    virtual void addArray(const dcpp::char_kt* attributeName, const dcpp::nub::array<dcpp::nub::wstring>& value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::array<dcpp::nub::wstring>& value) = 0;
 
    virtual dcpp::nub::array<dcpp::nub::wstring> getAttributeAsArray(const dcpp::char_kt* attributeName, const dcpp::nub::array<dcpp::nub::wstring>& defaultNotFound = dcpp::nub::array<dcpp::nub::wstring>()) const = 0;
 
    virtual dcpp::nub::array<dcpp::nub::wstring> getAttributeAsArray(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::array<dcpp::nub::wstring>& value) = 0;
 
 
    /*
 
        Bool Attribute
 
    */
 
    virtual void addBool(const dcpp::char_kt* attributeName, bool value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, bool value) = 0;
 
    virtual bool getAttributeAsBool(const dcpp::char_kt* attributeName, bool defaultNotFound=false) const = 0;
 
    virtual bool getAttributeAsBool(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, bool value) = 0;
 
    /*
 
        Enumeration Attribute
 
    */
 
    virtual void addEnum(const dcpp::char_kt* attributeName, const dcpp::char_kt* enumValue, const dcpp::char_kt* const* enumerationLiterals) = 0;
 
    virtual void addEnum(const dcpp::char_kt* attributeName, dcpp::int32_kt enumValue, const dcpp::char_kt* const* enumerationLiterals) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::char_kt* enumValue, const dcpp::char_kt* const* enumerationLiterals) = 0;
 
    virtual const dcpp::char_kt* getAttributeAsEnumeration(const dcpp::char_kt* attributeName, const dcpp::char_kt* defaultNotFound = 0) const = 0;
 
 
    virtual dcpp::int32_kt getAttributeAsEnumeration(const dcpp::char_kt* attributeName, const dcpp::char_kt* const* enumerationLiteralsToUse, dcpp::int32_kt defaultNotFound = -1) const = 0;
 
 
    virtual dcpp::int32_kt getAttributeAsEnumeration(dcpp::int32_kt index, const dcpp::char_kt* const* enumerationLiteralsToUse, dcpp::int32_kt defaultNotFound = -1) const = 0;
 
    virtual const dcpp::char_kt* getAttributeAsEnumeration(dcpp::int32_kt index) const = 0;
 
    virtual void getAttributeEnumerationLiteralsOfEnumeration(const dcpp::char_kt* attributeName, dcpp::nub::array<dcpp::nub::string>& outLiterals) const = 0;
 
    virtual void getAttributeEnumerationLiteralsOfEnumeration(dcpp::int32_kt index, dcpp::nub::array<dcpp::nub::string>& outLiterals) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::char_kt* enumValue, const dcpp::char_kt* const* enumerationLiterals) = 0;
 
 
    /*
 
        SColor Attribute
 
    */
 
    virtual void addColor(const dcpp::char_kt* attributeName, dcpp::video::SColor value) = 0;
 
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, dcpp::video::SColor color) = 0;
 
    virtual dcpp::video::SColor getAttributeAsColor(const dcpp::char_kt* attributeName, const dcpp::video::SColor& defaultNotFound = dcpp::video::SColor(0)) const = 0;
 
    virtual dcpp::video::SColor getAttributeAsColor(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, dcpp::video::SColor color) = 0;
 
    /*
 
        SColorf Attribute
 
    */
 
    virtual void addColorf(const dcpp::char_kt* attributeName, dcpp::video::SColorf value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, dcpp::video::SColorf color) = 0;
 
    virtual dcpp::video::SColorf getAttributeAsColorf(const dcpp::char_kt* attributeName, const dcpp::video::SColorf& defaultNotFound = dcpp::video::SColorf(0)) const = 0;
 
    virtual dcpp::video::SColorf getAttributeAsColorf(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, dcpp::video::SColorf color) = 0;
 
 
    /*
 
        Vector3d Attribute
 
    */
 
    virtual void addVector3d(const dcpp::char_kt* attributeName, const dcpp::nub::vector3df& value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::vector3df& v) = 0;
 
    virtual dcpp::nub::vector3df getAttributeAsVector3d(const dcpp::char_kt* attributeName, const dcpp::nub::vector3df& defaultNotFound=dcpp::nub::vector3df(0,0,0)) const = 0;
 
    virtual dcpp::nub::vector3df getAttributeAsVector3d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::vector3df& v) = 0;
 
    /*
 
        Vector2d Attribute
 
    */
 
    virtual void addVector2d(const dcpp::char_kt* attributeName, const dcpp::nub::vector2df& value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::vector2df& v) = 0;
 
    virtual dcpp::nub::vector2df getAttributeAsVector2d(const dcpp::char_kt* attributeName, const dcpp::nub::vector2df& defaultNotFound=dcpp::nub::vector2df(0,0)) const = 0;
 
    virtual dcpp::nub::vector2df getAttributeAsVector2d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::vector2df& v) = 0;
 
    /*
 
        Position2d Attribute
 
    */
 
    virtual void addPosition2d(const dcpp::char_kt* attributeName, const dcpp::nub::position2di& value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::position2di& v) = 0;
 
    virtual dcpp::nub::position2di getAttributeAsPosition2d(const dcpp::char_kt* attributeName, const dcpp::nub::position2di& defaultNotFound=dcpp::nub::position2di(0,0)) const = 0;
 
    virtual dcpp::nub::position2di getAttributeAsPosition2d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::position2di& v) = 0;
 
    /*
 
        Rectangle Attribute
 
    */
 
    virtual void addRect(const dcpp::char_kt* attributeName, const dcpp::nub::recti& value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::recti& v) = 0;
 
    virtual dcpp::nub::recti getAttributeAsRect(const dcpp::char_kt* attributeName, const dcpp::nub::recti& defaultNotFound = dcpp::nub::recti()) const = 0;
 
    virtual dcpp::nub::recti getAttributeAsRect(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::recti& v) = 0;
 
 
    /*
 
        Dimension2d Attribute
 
    */
 
    virtual void addDimension2d(const dcpp::char_kt* attributeName, const dcpp::nub::dimension2du& value) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::dimension2du& v) = 0;
 
    virtual dcpp::nub::dimension2du getAttributeAsDimension2d(const dcpp::char_kt* attributeName, const dcpp::nub::dimension2du& defaultNotFound = dcpp::nub::dimension2du()) const = 0;
 
    virtual dcpp::nub::dimension2du getAttributeAsDimension2d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::dimension2du& v) = 0;
 
 
    /*
        matrix attribute
    */
 
    virtual void addMatrix(const dcpp::char_kt* attributeName, const dcpp::nub::matrix4& v) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::matrix4& v) = 0;
 
    virtual dcpp::nub::matrix4 getAttributeAsMatrix(const dcpp::char_kt* attributeName, const dcpp::nub::matrix4& defaultNotFound=dcpp::nub::matrix4()) const = 0;
 
    virtual dcpp::nub::matrix4 getAttributeAsMatrix(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::matrix4& v) = 0;
 
    /*
        quaternion attribute
 
    */
 
    virtual void addQuaternion(const dcpp::char_kt* attributeName, const dcpp::nub::quaternion& v) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::quaternion& v) = 0;
 
    virtual dcpp::nub::quaternion getAttributeAsQuaternion(const dcpp::char_kt* attributeName, const dcpp::nub::quaternion& defaultNotFound=dcpp::nub::quaternion(0,1,0, 0)) const = 0;
 
    virtual dcpp::nub::quaternion getAttributeAsQuaternion(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::quaternion& v) = 0;
 
    /*
 
        3d bounding box
 
    */
 
    virtual void addBox3d(const dcpp::char_kt* attributeName, const dcpp::nub::aabbox3df& v) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::aabbox3df& v) = 0;
 
    virtual dcpp::nub::aabbox3df getAttributeAsBox3d(const dcpp::char_kt* attributeName, const dcpp::nub::aabbox3df& defaultNotFound=dcpp::nub::aabbox3df(0,0,0, 0,0,0)) const = 0;
 
    virtual dcpp::nub::aabbox3df getAttributeAsBox3d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::aabbox3df& v) = 0;
 
    /*
 
        plane
 
    */
 
    virtual void addPlane3d(const dcpp::char_kt* attributeName, const dcpp::nub::plane3df& v) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::plane3df& v) = 0;
 
    virtual dcpp::nub::plane3df getAttributeAsPlane3d(const dcpp::char_kt* attributeName, const dcpp::nub::plane3df& defaultNotFound=dcpp::nub::plane3df(0,0,0, 0,1,0)) const = 0;
 
    virtual dcpp::nub::plane3df getAttributeAsPlane3d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::plane3df& v) = 0;
 
 
    /*
 
        3d triangle
 
    */
 
    virtual void addTriangle3d(const dcpp::char_kt* attributeName, const dcpp::nub::triangle3df& v) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::triangle3df& v) = 0;
 
    virtual dcpp::nub::triangle3df getAttributeAsTriangle3d(const dcpp::char_kt* attributeName, const dcpp::nub::triangle3df& defaultNotFound = dcpp::nub::triangle3df(dcpp::nub::vector3df(0,0,0), dcpp::nub::vector3df(0,0,0), dcpp::nub::vector3df(0,0,0))) const = 0;
 
    virtual dcpp::nub::triangle3df getAttributeAsTriangle3d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::triangle3df& v) = 0;
 
 
    /*
 
        line 2d
 
    */
 
    virtual void addLine2d(const dcpp::char_kt* attributeName, const dcpp::nub::line2df& v) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::line2df& v) = 0;
 
    virtual dcpp::nub::line2df getAttributeAsLine2d(const dcpp::char_kt* attributeName, const dcpp::nub::line2df& defaultNotFound = dcpp::nub::line2df(0,0, 0,0)) const = 0;
 
    virtual dcpp::nub::line2df getAttributeAsLine2d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::line2df& v) = 0;
 
 
    /*
 
        line 3d
 
    */
 
    virtual void addLine3d(const dcpp::char_kt* attributeName, const dcpp::nub::line3df& v) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, const dcpp::nub::line3df& v) = 0;
 
    virtual dcpp::nub::line3df getAttributeAsLine3d(const dcpp::char_kt* attributeName, const dcpp::nub::line3df& defaultNotFound=dcpp::nub::line3df(0,0,0, 0,0,0)) const = 0;
 
    virtual dcpp::nub::line3df getAttributeAsLine3d(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, const dcpp::nub::line3df& v) = 0;
 
 
    /*
 
        Texture Attribute
 
    */
 
    virtual void addTexture(const dcpp::char_kt* attributeName, dcpp::video::ITexture* texture, const dcpp::io::path& filename = "") = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, dcpp::video::ITexture* texture, const dcpp::io::path& filename = "") = 0;
 
    virtual dcpp::video::ITexture* getAttributeAsTexture(const dcpp::char_kt* attributeName, dcpp::video::ITexture* defaultNotFound=0) const = 0;
 
    virtual dcpp::video::ITexture* getAttributeAsTexture(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, dcpp::video::ITexture* texture, const dcpp::io::path& filename = "") = 0;
 
 
    /*
 
        User Pointer Attribute
 
    */
 
    virtual void addUserPointer(const dcpp::char_kt* attributeName, void* userPointer) = 0;
 
    virtual void setAttribute(const dcpp::char_kt* attributeName, void* userPointer) = 0;
 
    virtual void* getAttributeAsUserPointer(const dcpp::char_kt* attributeName, void* defaultNotFound = 0) const = 0;
 
    virtual void* getAttributeAsUserPointer(dcpp::int32_kt index) const = 0;
 
    virtual void setAttribute(dcpp::int32_kt index, void* userPointer) = 0;
 
};
 
} // end namespace io
} // end namespace dcpp
 
#endif