IMeshBuffer.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_MESH_BUFFER_HPP_INCLUDED
#define NIRT_I_MESH_BUFFER_HPP_INCLUDED
 
#include <nirtcpp/core/engine/IReferenceCounted.hpp>
#include <nirtcpp/core/engine/SMaterial.hpp>
#include <nirtcpp/core/engine/aabbox3d.hpp>
#include <nirtcpp/core/engine/S3DVertex.hpp>
#include <nirtcpp/core/engine/SVertexIndex.hpp>
#include <nirtcpp/core/engine/EHardwareBufferFlags.hpp>
#include <nirtcpp/core/engine/EPrimitiveTypes.hpp>
#include <nirtcpp/core/engine/EMeshBufferTypes.hpp>
 
namespace nirt
{
namespace scene
{
 
    class IMeshBuffer : public virtual IReferenceCounted
    {
    public:
 
 
        virtual video::SMaterial& getMaterial() = 0;
 
 
        virtual const video::SMaterial& getMaterial() const = 0;
 
 
        virtual video::E_VERTEX_TYPE getVertexType() const = 0;
 
 
        virtual const void* getVertices() const = 0;
 
 
        virtual void* getVertices() = 0;
 
 
        virtual u32 getVertexCount() const = 0;
 
 
        virtual video::E_INDEX_TYPE getIndexType() const =0;
 
 
        virtual const u16* getIndices() const = 0;
 
 
        virtual u16* getIndices() = 0;
 
 
        virtual u32 getIndexCount() const = 0;
 
 
        virtual const core::aabbox3df& getBoundingBox() const = 0;
 
 
        virtual void setBoundingBox(const core::aabbox3df& box) = 0;
 
        virtual void recalculateBoundingBox() = 0;
 
        virtual const core::vector3df& getPosition(u32 i) const = 0;
 
        virtual core::vector3df& getPosition(u32 i) = 0;
 
        virtual const core::vector3df& getNormal(u32 i) const = 0;
 
        virtual core::vector3df& getNormal(u32 i) = 0;
 
        virtual const core::vector2df& getTCoords(u32 i) const = 0;
 
        virtual core::vector2df& getTCoords(u32 i) = 0;
 
        virtual video::SColor& getColor(u32 i) = 0;
 
        virtual const video::SColor& getColor(u32 i) const = 0;
 
 
        virtual void append(const void* const vertices, u32 numVertices, const u16* const indices, u32 numIndices) = 0;
 
 
        virtual void append(const IMeshBuffer* const other) = 0;
 
        virtual E_HARDWARE_MAPPING getHardwareMappingHint_Vertex() const = 0;
 
        virtual E_HARDWARE_MAPPING getHardwareMappingHint_Index() const = 0;
 
        virtual void setHardwareMappingHint( E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX ) = 0;
 
        virtual void setDirty(E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX) = 0;
 
 
        virtual u32 getChangedID_Vertex() const = 0;
 
 
        virtual u32 getChangedID_Index() const = 0;
 
 
        virtual void setPrimitiveType(E_PRIMITIVE_TYPE type) = 0;
 
        virtual E_PRIMITIVE_TYPE getPrimitiveType() const = 0;
 
        virtual u32 getPrimitiveCount() const
        {
            const u32 indexCount = getIndexCount();
            switch (getPrimitiveType())
            {
                case scene::EPT_POINTS:         return indexCount;
                case scene::EPT_LINE_STRIP:     return indexCount-1;
                case scene::EPT_LINE_LOOP:      return indexCount;
                case scene::EPT_LINES:          return indexCount/2;
                case scene::EPT_TRIANGLE_STRIP: return (indexCount-2);
                case scene::EPT_TRIANGLE_FAN:   return (indexCount-2);
                case scene::EPT_TRIANGLES:      return indexCount/3;
                case scene::EPT_QUAD_STRIP:     return (indexCount-2)/2;
                case scene::EPT_QUADS:          return indexCount/4;
                case scene::EPT_POLYGON:        return indexCount; // (not really primitives, that would be 1, works like line_strip)
                case scene::EPT_POINT_SPRITES:  return indexCount;
            }
            return 0;
        }
 
 
        virtual EMESH_BUFFER_TYPE getType() const
        {
            return EMBT_UNKNOWN;
        }
 
        enum ECloneFlags
        {
            ECF_VERTICES = 1,   
            ECF_INDICES = 2     
        };
 
        //\param cloneFlags A combination of ECloneFlags
        virtual IMeshBuffer* createClone(int cloneFlags=ECF_VERTICES|ECF_INDICES) const = 0;
 
    };
 
} // end namespace scene
} // end namespace nirt
 
#endif