OgreVertexIndexData.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __VertexIndexData_H__
#define __VertexIndexData_H__

#include "OgrePrerequisites.h"
#include "OgreHardwareVertexBuffer.h"
#include "OgreHardwareIndexBuffer.h"

namespace Ogre {

    typedef vector<HardwareBuffer::Usage>::type BufferUsageList;


    class _OgreExport VertexData : public VertexDataAlloc
    {
    private:
        VertexData(const VertexData& rhs); /* do nothing, should not use */
        VertexData& operator=(const VertexData& rhs); /* do not use */

        HardwareBufferManagerBase* mMgr;
    public:
        VertexData(HardwareBufferManagerBase* mgr = 0);
        VertexData(VertexDeclaration* dcl, VertexBufferBinding* bind);
        ~VertexData();

        VertexDeclaration* vertexDeclaration;
        VertexBufferBinding* vertexBufferBinding;
        bool mDeleteDclBinding;
        size_t vertexStart;
        size_t vertexCount;


        struct HardwareAnimationData
        {
            unsigned short targetBufferIndex;
            Real parametric;
        };
        typedef vector<HardwareAnimationData>::type HardwareAnimationDataList;
        HardwareAnimationDataList hwAnimationDataList;
        size_t hwAnimDataItemsUsed;
        
        VertexData* clone(bool copyData = true, HardwareBufferManagerBase* mgr = 0) const;

        void prepareForShadowVolume(void);

        HardwareVertexBufferSharedPtr hardwareShadowVolWBuffer;


        void reorganiseBuffers(VertexDeclaration* newDeclaration, const BufferUsageList& bufferUsage, 
            HardwareBufferManagerBase* mgr = 0);

        void reorganiseBuffers(VertexDeclaration* newDeclaration, HardwareBufferManagerBase* mgr = 0);

        void closeGapsInBindings(void);

        void removeUnusedBuffers(void);

        void convertPackedColour(VertexElementType srcType, VertexElementType destType);


        ushort allocateHardwareAnimationElements(ushort count, bool animateNormals);



    };

    class _OgreExport IndexData : public IndexDataAlloc
    {
    protected:
        IndexData(const IndexData& rhs); /* do nothing, should not use */
        IndexData& operator=(const IndexData& rhs); /* do not use */
    public:
        IndexData();
        ~IndexData();
        HardwareIndexBufferSharedPtr indexBuffer;

        size_t indexStart;

        size_t indexCount;

        IndexData* clone(bool copyData = true, HardwareBufferManagerBase* mgr = 0) const;

        void optimiseVertexCacheTriList(void);
    
    };

    class _OgreExport VertexCacheProfiler : public BufferAlloc
    {
        public:
            enum CacheType {
                FIFO, LRU
            };

            VertexCacheProfiler(unsigned int cachesize = 16, CacheType cachetype = FIFO )
                : size ( cachesize ), type ( cachetype ), tail (0), buffersize (0), hit (0), miss (0)
            {
                cache = OGRE_ALLOC_T(uint32, size, MEMCATEGORY_GEOMETRY);
            }

            ~VertexCacheProfiler()
            {
                OGRE_FREE(cache, MEMCATEGORY_GEOMETRY);
            }

            void profile(const HardwareIndexBufferSharedPtr& indexBuffer);
            void reset() { hit = 0; miss = 0; tail = 0; buffersize = 0; }
            void flush() { tail = 0; buffersize = 0; }

            unsigned int getHits() { return hit; }
            unsigned int getMisses() { return miss; }
            unsigned int getSize() { return size; }
        private:
            unsigned int size;
            uint32 *cache;
            CacheType type;

            unsigned int tail, buffersize;
            unsigned int hit, miss;

            bool inCache(unsigned int index);
    };
}
#endif