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 u32 getAttributeCount() const = 0;
 
    virtual const c8* getAttributeName(i32 index) const = 0;
 
    virtual E_ATTRIBUTE_TYPE getAttributeType(const c8* attributeName) const = 0;
 
    virtual E_ATTRIBUTE_TYPE getAttributeType(i32 index) const = 0;
 
    virtual const wchar_t* getAttributeTypeString(const c8* attributeName, const wchar_t* defaultNotFound = L"unknown") const = 0;
 
    virtual const wchar_t* getAttributeTypeString(i32 index, const wchar_t* defaultNotFound = L"unknown") const = 0;
 
    virtual bool existsAttribute(const c8* attributeName) const = 0;
 
    virtual i32 findAttribute(const c8* attributeName) const = 0;
 
    virtual void clear() = 0;
 
    virtual bool read(io::IXMLReader* reader, bool readCurrentElementOnly=false, const wchar_t* elementName=0) = 0;
 
    virtual bool write(io::IXMLWriter* writer, bool writeXMLHeader=false, const wchar_t* elementName=0) = 0;
 
 
    /*
 
        Integer Attribute
 
    */
 
    virtual void addInt(const c8* attributeName, i32 value) = 0;
 
    virtual void setAttribute(const c8* attributeName, i32 value) = 0;
 
    virtual i32 getAttributeAsInt(const c8* attributeName, dcpp::i32 defaultNotFound=0) const = 0;
 
    virtual i32 getAttributeAsInt(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, i32 value) = 0;
 
    /*
 
        Float Attribute
 
    */
 
    virtual void addFloat(const c8* attributeName, f32 value) = 0;
 
    virtual void setAttribute(const c8* attributeName, f32 value) = 0;
 
    virtual f32 getAttributeAsFloat(const c8* attributeName, dcpp::f32 defaultNotFound=0.f) const = 0;
 
    virtual f32 getAttributeAsFloat(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, f32 value) = 0;
 
    /*
 
        String Attribute
 
    */
 
    virtual void addString(const c8* attributeName, const c8* value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const c8* value) = 0;
 
    virtual dcpp::nub::string getAttributeAsString(const c8* attributeName, const dcpp::nub::string& defaultNotFound=dcpp::nub::string()) const = 0;
 
    virtual void getAttributeAsString(const c8* attributeName, c8* target) const = 0;
 
    virtual dcpp::nub::string getAttributeAsString(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const c8* value) = 0;
 
    // wide strings
 
    virtual void addString(const c8* attributeName, const wchar_t* value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const wchar_t* value) = 0;
 
    virtual nub::wstring getAttributeAsWstring(const c8* attributeName, const nub::wstring& defaultNotFound = nub::wstring()) const = 0;
 
    virtual void getAttributeAsWstring(const c8* attributeName, wchar_t* target) const = 0;
 
    virtual nub::wstring getAttributeAsWstring(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const wchar_t* value) = 0;
 
    /*
 
        Binary Data Attribute
 
    */
 
    virtual void addBinary(const c8* attributeName, void* data, i32 dataSizeInBytes) = 0;
 
    virtual void setAttribute(const c8* attributeName, void* data, i32 dataSizeInBytes ) = 0;
 
 
    virtual void getAttributeAsBinaryData(const c8* attributeName, void* outData, i32 maxSizeInBytes) const = 0;
 
 
    virtual void getAttributeAsBinaryData(i32 index, void* outData, i32 maxSizeInBytes) const = 0;
 
    virtual void setAttribute(i32 index, void* data, i32 dataSizeInBytes ) = 0;
 
 
    /*
        Array Attribute
    */
 
    virtual void addArray(const c8* attributeName, const nub::array<nub::wstring>& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::array<nub::wstring>& value) = 0;
 
    virtual nub::array<nub::wstring> getAttributeAsArray(const c8* attributeName, const nub::array<nub::wstring>& defaultNotFound = nub::array<nub::wstring>()) const = 0;
 
    virtual nub::array<nub::wstring> getAttributeAsArray(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::array<nub::wstring>& value) = 0;
 
 
    /*
 
        Bool Attribute
 
    */
 
    virtual void addBool(const c8* attributeName, bool value) = 0;
 
    virtual void setAttribute(const c8* attributeName, bool value) = 0;
 
    virtual bool getAttributeAsBool(const c8* attributeName, bool defaultNotFound=false) const = 0;
 
    virtual bool getAttributeAsBool(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, bool value) = 0;
 
    /*
 
        Enumeration Attribute
 
    */
 
    virtual void addEnum(const c8* attributeName, const c8* enumValue, const c8* const* enumerationLiterals) = 0;
 
    virtual void addEnum(const c8* attributeName, i32 enumValue, const c8* const* enumerationLiterals) = 0;
 
    virtual void setAttribute(const c8* attributeName, const c8* enumValue, const c8* const* enumerationLiterals) = 0;
 
    virtual const c8* getAttributeAsEnumeration(const c8* attributeName, const c8* defaultNotFound = 0) const = 0;
 
 
    virtual i32 getAttributeAsEnumeration(const c8* attributeName, const c8* const* enumerationLiteralsToUse, i32 defaultNotFound = -1) const = 0;
 
 
    virtual i32 getAttributeAsEnumeration(i32 index, const c8* const* enumerationLiteralsToUse, i32 defaultNotFound = -1) const = 0;
 
    virtual const c8* getAttributeAsEnumeration(i32 index) const = 0;
 
    virtual void getAttributeEnumerationLiteralsOfEnumeration(const c8* attributeName, nub::array<dcpp::nub::string>& outLiterals) const = 0;
 
    virtual void getAttributeEnumerationLiteralsOfEnumeration(i32 index, nub::array<dcpp::nub::string>& outLiterals) const = 0;
 
    virtual void setAttribute(i32 index, const c8* enumValue, const c8* const* enumerationLiterals) = 0;
 
 
    /*
 
        SColor Attribute
 
    */
 
    virtual void addColor(const c8* attributeName, video::SColor value) = 0;
 
 
    virtual void setAttribute(const c8* attributeName, video::SColor color) = 0;
 
    virtual video::SColor getAttributeAsColor(const c8* attributeName, const video::SColor& defaultNotFound = video::SColor(0)) const = 0;
 
    virtual video::SColor getAttributeAsColor(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, video::SColor color) = 0;
 
    /*
 
        SColorf Attribute
 
    */
 
    virtual void addColorf(const c8* attributeName, video::SColorf value) = 0;
 
    virtual void setAttribute(const c8* attributeName, video::SColorf color) = 0;
 
    virtual video::SColorf getAttributeAsColorf(const c8* attributeName, const video::SColorf& defaultNotFound = video::SColorf(0)) const = 0;
 
    virtual video::SColorf getAttributeAsColorf(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, video::SColorf color) = 0;
 
 
    /*
 
        Vector3d Attribute
 
    */
 
    virtual void addVector3d(const c8* attributeName, const nub::vector3df& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::vector3df& v) = 0;
 
    virtual nub::vector3df getAttributeAsVector3d(const c8* attributeName, const nub::vector3df& defaultNotFound=nub::vector3df(0,0,0)) const = 0;
 
    virtual nub::vector3df getAttributeAsVector3d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::vector3df& v) = 0;
 
    /*
 
        Vector2d Attribute
 
    */
 
    virtual void addVector2d(const c8* attributeName, const nub::vector2df& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::vector2df& v) = 0;
 
    virtual nub::vector2df getAttributeAsVector2d(const c8* attributeName, const nub::vector2df& defaultNotFound=nub::vector2df(0,0)) const = 0;
 
    virtual nub::vector2df getAttributeAsVector2d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::vector2df& v) = 0;
 
    /*
 
        Position2d Attribute
 
    */
 
    virtual void addPosition2d(const c8* attributeName, const nub::position2di& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::position2di& v) = 0;
 
    virtual nub::position2di getAttributeAsPosition2d(const c8* attributeName, const nub::position2di& defaultNotFound=nub::position2di(0,0)) const = 0;
 
    virtual nub::position2di getAttributeAsPosition2d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::position2di& v) = 0;
 
    /*
 
        Rectangle Attribute
 
    */
 
    virtual void addRect(const c8* attributeName, const nub::rect<i32>& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::rect<i32>& v) = 0;
 
    virtual nub::rect<i32> getAttributeAsRect(const c8* attributeName, const nub::rect<i32>& defaultNotFound = nub::rect<i32>()) const = 0;
 
    virtual nub::rect<i32> getAttributeAsRect(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::rect<i32>& v) = 0;
 
 
    /*
 
        Dimension2d Attribute
 
    */
 
    virtual void addDimension2d(const c8* attributeName, const nub::dimension2d<u32>& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::dimension2d<u32>& v) = 0;
 
    virtual nub::dimension2d<u32> getAttributeAsDimension2d(const c8* attributeName, const nub::dimension2d<u32>& defaultNotFound = nub::dimension2d<u32>()) const = 0;
 
    virtual nub::dimension2d<u32> getAttributeAsDimension2d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::dimension2d<u32>& v) = 0;
 
 
    /*
        matrix attribute
    */
 
    virtual void addMatrix(const c8* attributeName, const nub::matrix4& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::matrix4& v) = 0;
 
    virtual nub::matrix4 getAttributeAsMatrix(const c8* attributeName, const nub::matrix4& defaultNotFound=nub::matrix4()) const = 0;
 
    virtual nub::matrix4 getAttributeAsMatrix(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::matrix4& v) = 0;
 
    /*
        quaternion attribute
 
    */
 
    virtual void addQuaternion(const c8* attributeName, const nub::quaternion& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::quaternion& v) = 0;
 
    virtual nub::quaternion getAttributeAsQuaternion(const c8* attributeName, const nub::quaternion& defaultNotFound=nub::quaternion(0,1,0, 0)) const = 0;
 
    virtual nub::quaternion getAttributeAsQuaternion(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::quaternion& v) = 0;
 
    /*
 
        3d bounding box
 
    */
 
    virtual void addBox3d(const c8* attributeName, const nub::aabbox3df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::aabbox3df& v) = 0;
 
    virtual nub::aabbox3df getAttributeAsBox3d(const c8* attributeName, const nub::aabbox3df& defaultNotFound=nub::aabbox3df(0,0,0, 0,0,0)) const = 0;
 
    virtual nub::aabbox3df getAttributeAsBox3d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::aabbox3df& v) = 0;
 
    /*
 
        plane
 
    */
 
    virtual void addPlane3d(const c8* attributeName, const nub::plane3df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::plane3df& v) = 0;
 
    virtual nub::plane3df getAttributeAsPlane3d(const c8* attributeName, const nub::plane3df& defaultNotFound=nub::plane3df(0,0,0, 0,1,0)) const = 0;
 
    virtual nub::plane3df getAttributeAsPlane3d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::plane3df& v) = 0;
 
 
    /*
 
        3d triangle
 
    */
 
    virtual void addTriangle3d(const c8* attributeName, const nub::triangle3df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::triangle3df& v) = 0;
 
    virtual nub::triangle3df getAttributeAsTriangle3d(const c8* attributeName, const nub::triangle3df& defaultNotFound = nub::triangle3df(nub::vector3df(0,0,0), nub::vector3df(0,0,0), nub::vector3df(0,0,0))) const = 0;
 
    virtual nub::triangle3df getAttributeAsTriangle3d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::triangle3df& v) = 0;
 
 
    /*
 
        line 2d
 
    */
 
    virtual void addLine2d(const c8* attributeName, const nub::line2df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::line2df& v) = 0;
 
    virtual nub::line2df getAttributeAsLine2d(const c8* attributeName, const nub::line2df& defaultNotFound = nub::line2df(0,0, 0,0)) const = 0;
 
    virtual nub::line2df getAttributeAsLine2d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::line2df& v) = 0;
 
 
    /*
 
        line 3d
 
    */
 
    virtual void addLine3d(const c8* attributeName, const nub::line3df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const nub::line3df& v) = 0;
 
    virtual nub::line3df getAttributeAsLine3d(const c8* attributeName, const nub::line3df& defaultNotFound=nub::line3df(0,0,0, 0,0,0)) const = 0;
 
    virtual nub::line3df getAttributeAsLine3d(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, const nub::line3df& v) = 0;
 
 
    /*
 
        Texture Attribute
 
    */
 
    virtual void addTexture(const c8* attributeName, video::ITexture* texture, const io::path& filename = "") = 0;
 
    virtual void setAttribute(const c8* attributeName, video::ITexture* texture, const io::path& filename = "") = 0;
 
    virtual video::ITexture* getAttributeAsTexture(const c8* attributeName, video::ITexture* defaultNotFound=0) const = 0;
 
    virtual video::ITexture* getAttributeAsTexture(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, video::ITexture* texture, const io::path& filename = "") = 0;
 
 
    /*
 
        User Pointer Attribute
 
    */
 
    virtual void addUserPointer(const c8* attributeName, void* userPointer) = 0;
 
    virtual void setAttribute(const c8* attributeName, void* userPointer) = 0;
 
    virtual void* getAttributeAsUserPointer(const c8* attributeName, void* defaultNotFound = 0) const = 0;
 
    virtual void* getAttributeAsUserPointer(i32 index) const = 0;
 
    virtual void setAttribute(i32 index, void* userPointer) = 0;
 
};
 
} // end namespace io
} // end namespace dcpp
 
#endif