2013-07-22 08:41:12 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2017-08-08 12:25:03 +00:00
|
|
|
* Copyright 2013-2017 CERN
|
2020-12-21 23:42:21 +00:00
|
|
|
* Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
|
|
|
|
*
|
2013-07-22 08:41:12 +00:00
|
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, you may find one here:
|
|
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef CACHED_CONTAINER_H_
|
|
|
|
#define CACHED_CONTAINER_H_
|
|
|
|
|
|
|
|
#include <gal/opengl/vertex_container.h>
|
|
|
|
#include <map>
|
|
|
|
#include <set>
|
|
|
|
|
2013-10-14 14:13:35 +00:00
|
|
|
namespace KIGFX
|
2013-07-22 08:41:12 +00:00
|
|
|
{
|
|
|
|
class VERTEX_ITEM;
|
|
|
|
class SHADER;
|
|
|
|
|
2017-08-08 12:25:03 +00:00
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Class to store VERTEX instances with caching.
|
|
|
|
*
|
|
|
|
* It associates VERTEX objects and with VERTEX_ITEMs. Caching vertices data in the memory and a
|
2017-08-08 12:25:03 +00:00
|
|
|
* enables fast reuse of that data.
|
|
|
|
*/
|
|
|
|
|
2013-07-22 08:41:12 +00:00
|
|
|
class CACHED_CONTAINER : public VERTEX_CONTAINER
|
|
|
|
{
|
|
|
|
public:
|
2017-08-08 12:25:03 +00:00
|
|
|
CACHED_CONTAINER( unsigned int aSize = DEFAULT_SIZE );
|
|
|
|
virtual ~CACHED_CONTAINER() {}
|
|
|
|
|
|
|
|
bool IsCached() const override
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
2013-07-22 08:41:12 +00:00
|
|
|
|
2013-10-14 18:40:36 +00:00
|
|
|
///> @copydoc VERTEX_CONTAINER::SetItem()
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual void SetItem( VERTEX_ITEM* aItem ) override;
|
2013-07-22 08:41:12 +00:00
|
|
|
|
2013-10-14 18:40:36 +00:00
|
|
|
///> @copydoc VERTEX_CONTAINER::FinishItem()
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual void FinishItem() override;
|
2013-09-12 07:44:57 +00:00
|
|
|
|
2013-10-14 18:40:36 +00:00
|
|
|
///> @copydoc VERTEX_CONTAINER::Allocate()
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual VERTEX* Allocate( unsigned int aSize ) override;
|
2013-07-22 08:41:12 +00:00
|
|
|
|
2013-10-14 18:40:36 +00:00
|
|
|
///> @copydoc VERTEX_CONTAINER::Delete()
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual void Delete( VERTEX_ITEM* aItem ) override;
|
2013-07-22 08:41:12 +00:00
|
|
|
|
2013-10-14 18:40:36 +00:00
|
|
|
///> @copydoc VERTEX_CONTAINER::Clear()
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual void Clear() override;
|
2013-07-22 08:41:12 +00:00
|
|
|
|
2016-05-02 14:12:16 +00:00
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Return handle to the vertex buffer. It might be negative if the buffer is not initialized.
|
2016-05-02 14:12:16 +00:00
|
|
|
*/
|
2017-08-08 12:25:03 +00:00
|
|
|
virtual unsigned int GetBufferHandle() const = 0;
|
2016-05-02 14:12:16 +00:00
|
|
|
|
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Return true if vertex buffer is currently mapped.
|
2016-05-02 14:12:16 +00:00
|
|
|
*/
|
2017-08-08 12:25:03 +00:00
|
|
|
virtual bool IsMapped() const = 0;
|
2016-05-02 14:12:16 +00:00
|
|
|
|
|
|
|
///> @copydoc VERTEX_CONTAINER::Map()
|
2017-08-08 12:25:03 +00:00
|
|
|
virtual void Map() override = 0;
|
2016-05-02 14:12:16 +00:00
|
|
|
|
|
|
|
///> @copydoc VERTEX_CONTAINER::Unmap()
|
2017-08-08 12:25:03 +00:00
|
|
|
virtual void Unmap() override = 0;
|
2016-05-02 14:12:16 +00:00
|
|
|
|
2013-07-22 08:41:12 +00:00
|
|
|
protected:
|
2013-10-14 18:40:36 +00:00
|
|
|
///> Maps size of free memory chunks to their offsets
|
|
|
|
typedef std::pair<unsigned int, unsigned int> CHUNK;
|
|
|
|
typedef std::multimap<unsigned int, unsigned int> FREE_CHUNK_MAP;
|
2013-07-22 08:41:12 +00:00
|
|
|
|
|
|
|
/// List of all the stored items
|
2013-10-14 18:40:36 +00:00
|
|
|
typedef std::set<VERTEX_ITEM*> ITEMS;
|
2013-07-22 08:41:12 +00:00
|
|
|
|
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Resize the chunk that stores the current item to the given size. The current item has
|
2016-05-02 14:12:17 +00:00
|
|
|
* its offset adjusted after the call, and the new chunk parameters are stored
|
|
|
|
* in m_chunkOffset and m_chunkSize.
|
2013-07-30 16:29:54 +00:00
|
|
|
*
|
2016-05-02 14:12:17 +00:00
|
|
|
* @param aSize is the requested chunk size.
|
2020-12-21 23:42:21 +00:00
|
|
|
* @return true in case of success, false otherwise.
|
2013-07-30 16:29:54 +00:00
|
|
|
*/
|
2016-05-02 14:12:17 +00:00
|
|
|
bool reallocate( unsigned int aSize );
|
2013-07-22 08:41:12 +00:00
|
|
|
|
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Remove empty spaces between chunks and optionally resizes the container.
|
2013-07-22 08:41:12 +00:00
|
|
|
*
|
2020-12-21 23:42:21 +00:00
|
|
|
* After the operation there is continuous space for storing vertices at the end of the
|
|
|
|
* container.
|
|
|
|
*
|
|
|
|
* @param aNewSize is the new size of container, expressed in number of vertices.
|
|
|
|
* @return false in case of failure (e.g. memory shortage).
|
2013-07-22 08:41:12 +00:00
|
|
|
*/
|
2017-08-08 12:25:03 +00:00
|
|
|
virtual bool defragmentResize( unsigned int aNewSize ) = 0;
|
|
|
|
|
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Transfer all stored data to a new buffer, removing empty spaces between the data chunks
|
2017-08-08 12:25:03 +00:00
|
|
|
* in the container.
|
2020-12-21 23:42:21 +00:00
|
|
|
*
|
2017-08-08 12:25:03 +00:00
|
|
|
* @param aTarget is the destination for the defragmented data.
|
|
|
|
*/
|
|
|
|
void defragment( VERTEX* aTarget );
|
2013-07-22 08:41:12 +00:00
|
|
|
|
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Look for consecutive free memory chunks and merges them, decreasing fragmentation of
|
2013-07-22 08:41:12 +00:00
|
|
|
* memory.
|
|
|
|
*/
|
2016-05-02 14:12:16 +00:00
|
|
|
void mergeFreeChunks();
|
2013-07-22 08:41:12 +00:00
|
|
|
|
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Return the size of a chunk.
|
2013-07-22 08:41:12 +00:00
|
|
|
*
|
|
|
|
* @param aChunk is the chunk.
|
|
|
|
*/
|
2013-10-14 18:40:36 +00:00
|
|
|
inline int getChunkSize( const CHUNK& aChunk ) const
|
2013-07-22 08:41:12 +00:00
|
|
|
{
|
|
|
|
return aChunk.first;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Return the offset of a chunk.
|
2013-07-22 08:41:12 +00:00
|
|
|
*
|
|
|
|
* @param aChunk is the chunk.
|
|
|
|
*/
|
2013-10-14 18:40:36 +00:00
|
|
|
inline unsigned int getChunkOffset( const CHUNK& aChunk ) const
|
2013-07-22 08:41:12 +00:00
|
|
|
{
|
|
|
|
return aChunk.second;
|
|
|
|
}
|
|
|
|
|
2016-05-02 14:12:16 +00:00
|
|
|
/**
|
2020-12-21 23:42:21 +00:00
|
|
|
* Add a chunk marked as a free space.
|
2016-05-02 14:12:16 +00:00
|
|
|
*/
|
|
|
|
void addFreeChunk( unsigned int aOffset, unsigned int aSize );
|
|
|
|
|
2020-12-21 23:42:21 +00:00
|
|
|
///> Store size & offset of free chunks.
|
|
|
|
FREE_CHUNK_MAP m_freeChunks;
|
|
|
|
|
|
|
|
///> Stored VERTEX_ITEMs
|
|
|
|
ITEMS m_items;
|
|
|
|
|
|
|
|
///> Currently modified item
|
|
|
|
VERTEX_ITEM* m_item;
|
|
|
|
|
|
|
|
///> Properties of currently modified chunk & item
|
|
|
|
unsigned int m_chunkSize;
|
|
|
|
unsigned int m_chunkOffset;
|
|
|
|
|
|
|
|
///> Maximal vertex index number stored in the container
|
|
|
|
unsigned int m_maxIndex;
|
|
|
|
|
2017-08-08 12:25:03 +00:00
|
|
|
private:
|
2013-07-22 08:41:12 +00:00
|
|
|
/// Debug & test functions
|
|
|
|
void showFreeChunks();
|
2016-05-02 14:12:16 +00:00
|
|
|
void showUsedChunks();
|
2013-07-22 08:41:12 +00:00
|
|
|
void test();
|
|
|
|
};
|
2013-10-14 14:13:35 +00:00
|
|
|
} // namespace KIGFX
|
2013-07-22 08:41:12 +00:00
|
|
|
|
|
|
|
#endif /* CACHED_CONTAINER_H_ */
|