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 nirtcpp/nirtcpp.hpp
 
#ifndef NIRT_I_ATTRIBUTES_HPP_INCLUDED
#define NIRT_I_ATTRIBUTES_HPP_INCLUDED
 
#include <nirtcpp/core/engine/IReferenceCounted.hpp>
#include <nirtcpp/core/engine/SColor.hpp>
#include <nirtcpp/core/engine/vector3d.hpp>
#include <nirtcpp/core/engine/vector2d.hpp>
#include <nirtcpp/core/engine/line2d.hpp>
#include <nirtcpp/core/engine/line3d.hpp>
#include <nirtcpp/core/engine/triangle3d.hpp>
#include <nirtcpp/core/engine/position2d.hpp>
#include <nirtcpp/core/engine/rect.hpp>
#include <nirtcpp/core/engine/dimension2d.hpp>
#include <nirtcpp/core/engine/matrix4.hpp>
#include <nirtcpp/core/engine/quaternion.hpp>
#include <nirtcpp/core/engine/plane3d.hpp>
#include <nirtcpp/core/engine/triangle3d.hpp>
#include <nirtcpp/core/engine/line2d.hpp>
#include <nirtcpp/core/engine/line3d.hpp>
#include <nirtcpp/core/engine/irrString.hpp>
#include <nirtcpp/core/engine/irrArray.hpp>
#include <nirtcpp/core/engine/IXMLReader.hpp>
#include <nirtcpp/core/engine/IXMLWriter.hpp>
#include <nirtcpp/core/engine/EAttributes.hpp>
#include <nirtcpp/core/engine/path.hpp>
 
namespace nirt
{
namespace video
{
    class ITexture;
} // end namespace video
namespace io
{
 
class IAttributes : public virtual IReferenceCounted
{
public:
 
    virtual u32 getAttributeCount() const = 0;
 
    virtual const c8* getAttributeName(s32 index) const = 0;
 
    virtual E_ATTRIBUTE_TYPE getAttributeType(const c8* attributeName) const = 0;
 
    virtual E_ATTRIBUTE_TYPE getAttributeType(s32 index) const = 0;
 
    virtual const wchar_t* getAttributeTypeString(const c8* attributeName, const wchar_t* defaultNotFound = L"unknown") const = 0;
 
    virtual const wchar_t* getAttributeTypeString(s32 index, const wchar_t* defaultNotFound = L"unknown") const = 0;
 
    virtual bool existsAttribute(const c8* attributeName) const = 0;
 
    virtual s32 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, s32 value) = 0;
 
    virtual void setAttribute(const c8* attributeName, s32 value) = 0;
 
    virtual s32 getAttributeAsInt(const c8* attributeName, nirt::s32 defaultNotFound=0) const = 0;
 
    virtual s32 getAttributeAsInt(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, s32 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, nirt::f32 defaultNotFound=0.f) const = 0;
 
    virtual f32 getAttributeAsFloat(s32 index) const = 0;
 
    virtual void setAttribute(s32 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 core::stringc getAttributeAsString(const c8* attributeName, const core::stringc& defaultNotFound=core::stringc()) const = 0;
 
    virtual void getAttributeAsString(const c8* attributeName, c8* target) const = 0;
 
    virtual core::stringc getAttributeAsString(s32 index) const = 0;
 
    virtual void setAttribute(s32 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 core::stringw getAttributeAsStringW(const c8* attributeName, const core::stringw& defaultNotFound = core::stringw()) const = 0;
 
    virtual void getAttributeAsStringW(const c8* attributeName, wchar_t* target) const = 0;
 
    virtual core::stringw getAttributeAsStringW(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const wchar_t* value) = 0;
 
    /*
 
        Binary Data Attribute
 
    */
 
    virtual void addBinary(const c8* attributeName, void* data, s32 dataSizeInBytes) = 0;
 
    virtual void setAttribute(const c8* attributeName, void* data, s32 dataSizeInBytes ) = 0;
 
 
    virtual void getAttributeAsBinaryData(const c8* attributeName, void* outData, s32 maxSizeInBytes) const = 0;
 
 
    virtual void getAttributeAsBinaryData(s32 index, void* outData, s32 maxSizeInBytes) const = 0;
 
    virtual void setAttribute(s32 index, void* data, s32 dataSizeInBytes ) = 0;
 
 
    /*
        Array Attribute
    */
 
    virtual void addArray(const c8* attributeName, const core::array<core::stringw>& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::array<core::stringw>& value) = 0;
 
    virtual core::array<core::stringw> getAttributeAsArray(const c8* attributeName, const core::array<core::stringw>& defaultNotFound = core::array<core::stringw>()) const = 0;
 
    virtual core::array<core::stringw> getAttributeAsArray(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::array<core::stringw>& 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(s32 index) const = 0;
 
    virtual void setAttribute(s32 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, s32 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 s32 getAttributeAsEnumeration(const c8* attributeName, const c8* const* enumerationLiteralsToUse, s32 defaultNotFound = -1) const = 0;
 
 
    virtual s32 getAttributeAsEnumeration(s32 index, const c8* const* enumerationLiteralsToUse, s32 defaultNotFound = -1) const = 0;
 
    virtual const c8* getAttributeAsEnumeration(s32 index) const = 0;
 
    virtual void getAttributeEnumerationLiteralsOfEnumeration(const c8* attributeName, core::array<core::stringc>& outLiterals) const = 0;
 
    virtual void getAttributeEnumerationLiteralsOfEnumeration(s32 index, core::array<core::stringc>& outLiterals) const = 0;
 
    virtual void setAttribute(s32 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(s32 index) const = 0;
 
    virtual void setAttribute(s32 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(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, video::SColorf color) = 0;
 
 
    /*
 
        Vector3d Attribute
 
    */
 
    virtual void addVector3d(const c8* attributeName, const core::vector3df& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::vector3df& v) = 0;
 
    virtual core::vector3df getAttributeAsVector3d(const c8* attributeName, const core::vector3df& defaultNotFound=core::vector3df(0,0,0)) const = 0;
 
    virtual core::vector3df getAttributeAsVector3d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::vector3df& v) = 0;
 
    /*
 
        Vector2d Attribute
 
    */
 
    virtual void addVector2d(const c8* attributeName, const core::vector2df& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::vector2df& v) = 0;
 
    virtual core::vector2df getAttributeAsVector2d(const c8* attributeName, const core::vector2df& defaultNotFound=core::vector2df(0,0)) const = 0;
 
    virtual core::vector2df getAttributeAsVector2d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::vector2df& v) = 0;
 
    /*
 
        Position2d Attribute
 
    */
 
    virtual void addPosition2d(const c8* attributeName, const core::position2di& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::position2di& v) = 0;
 
    virtual core::position2di getAttributeAsPosition2d(const c8* attributeName, const core::position2di& defaultNotFound=core::position2di(0,0)) const = 0;
 
    virtual core::position2di getAttributeAsPosition2d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::position2di& v) = 0;
 
    /*
 
        Rectangle Attribute
 
    */
 
    virtual void addRect(const c8* attributeName, const core::rect<s32>& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::rect<s32>& v) = 0;
 
    virtual core::rect<s32> getAttributeAsRect(const c8* attributeName, const core::rect<s32>& defaultNotFound = core::rect<s32>()) const = 0;
 
    virtual core::rect<s32> getAttributeAsRect(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::rect<s32>& v) = 0;
 
 
    /*
 
        Dimension2d Attribute
 
    */
 
    virtual void addDimension2d(const c8* attributeName, const core::dimension2d<u32>& value) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::dimension2d<u32>& v) = 0;
 
    virtual core::dimension2d<u32> getAttributeAsDimension2d(const c8* attributeName, const core::dimension2d<u32>& defaultNotFound = core::dimension2d<u32>()) const = 0;
 
    virtual core::dimension2d<u32> getAttributeAsDimension2d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::dimension2d<u32>& v) = 0;
 
 
    /*
        matrix attribute
    */
 
    virtual void addMatrix(const c8* attributeName, const core::matrix4& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::matrix4& v) = 0;
 
    virtual core::matrix4 getAttributeAsMatrix(const c8* attributeName, const core::matrix4& defaultNotFound=core::matrix4()) const = 0;
 
    virtual core::matrix4 getAttributeAsMatrix(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::matrix4& v) = 0;
 
    /*
        quaternion attribute
 
    */
 
    virtual void addQuaternion(const c8* attributeName, const core::quaternion& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::quaternion& v) = 0;
 
    virtual core::quaternion getAttributeAsQuaternion(const c8* attributeName, const core::quaternion& defaultNotFound=core::quaternion(0,1,0, 0)) const = 0;
 
    virtual core::quaternion getAttributeAsQuaternion(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::quaternion& v) = 0;
 
    /*
 
        3d bounding box
 
    */
 
    virtual void addBox3d(const c8* attributeName, const core::aabbox3df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::aabbox3df& v) = 0;
 
    virtual core::aabbox3df getAttributeAsBox3d(const c8* attributeName, const core::aabbox3df& defaultNotFound=core::aabbox3df(0,0,0, 0,0,0)) const = 0;
 
    virtual core::aabbox3df getAttributeAsBox3d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::aabbox3df& v) = 0;
 
    /*
 
        plane
 
    */
 
    virtual void addPlane3d(const c8* attributeName, const core::plane3df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::plane3df& v) = 0;
 
    virtual core::plane3df getAttributeAsPlane3d(const c8* attributeName, const core::plane3df& defaultNotFound=core::plane3df(0,0,0, 0,1,0)) const = 0;
 
    virtual core::plane3df getAttributeAsPlane3d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::plane3df& v) = 0;
 
 
    /*
 
        3d triangle
 
    */
 
    virtual void addTriangle3d(const c8* attributeName, const core::triangle3df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::triangle3df& v) = 0;
 
    virtual core::triangle3df getAttributeAsTriangle3d(const c8* attributeName, const core::triangle3df& defaultNotFound = core::triangle3df(core::vector3df(0,0,0), core::vector3df(0,0,0), core::vector3df(0,0,0))) const = 0;
 
    virtual core::triangle3df getAttributeAsTriangle3d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::triangle3df& v) = 0;
 
 
    /*
 
        line 2d
 
    */
 
    virtual void addLine2d(const c8* attributeName, const core::line2df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::line2df& v) = 0;
 
    virtual core::line2df getAttributeAsLine2d(const c8* attributeName, const core::line2df& defaultNotFound = core::line2df(0,0, 0,0)) const = 0;
 
    virtual core::line2df getAttributeAsLine2d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::line2df& v) = 0;
 
 
    /*
 
        line 3d
 
    */
 
    virtual void addLine3d(const c8* attributeName, const core::line3df& v) = 0;
 
    virtual void setAttribute(const c8* attributeName, const core::line3df& v) = 0;
 
    virtual core::line3df getAttributeAsLine3d(const c8* attributeName, const core::line3df& defaultNotFound=core::line3df(0,0,0, 0,0,0)) const = 0;
 
    virtual core::line3df getAttributeAsLine3d(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, const core::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(s32 index) const = 0;
 
    virtual void setAttribute(s32 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(s32 index) const = 0;
 
    virtual void setAttribute(s32 index, void* userPointer) = 0;
 
};
 
} // end namespace io
} // end namespace nirt
 
#endif