vertex_container.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright 2013-2017 CERN
 * Copyright (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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 VERTEX_CONTAINER_H_
#define VERTEX_CONTAINER_H_
 
#include <gal/opengl/vertex_common.h>
 
namespace KIGFX
{
class VERTEX_ITEM;
class SHADER;
 
class VERTEX_CONTAINER
{
public:
    static VERTEX_CONTAINER* MakeContainer( bool aCached );
 
    virtual ~VERTEX_CONTAINER();
 
    virtual bool IsCached() const = 0;
 
    virtual void Map() {}
 
    virtual void Unmap() {}
 
    virtual void SetItem( VERTEX_ITEM* aItem ) = 0;
 
    virtual void FinishItem() {};
 
    virtual VERTEX* Allocate( unsigned int aSize ) = 0;
 
    virtual void Delete( VERTEX_ITEM* aItem ) = 0;
 
    virtual void Clear() = 0;
 
    VERTEX* GetAllVertices() const
    {
        return m_vertices;
    }
 
    virtual VERTEX* GetVertices( unsigned int aOffset ) const
    {
        return &m_vertices[aOffset];
    }
 
    virtual unsigned int GetSize() const
    {
        return m_currentSize;
    }
 
    bool IsDirty() const
    {
        return m_dirty;
    }
 
    void SetDirty()
    {
        m_dirty = true;
    }
 
    void ClearDirty()
    {
        m_dirty = false;
    }
 
protected:
    VERTEX_CONTAINER( unsigned int aSize = DEFAULT_SIZE );
 
    unsigned int usedSpace() const
    {
        return m_currentSize - m_freeSpace;
    }
 
    unsigned int    m_freeSpace;
 
    unsigned int    m_currentSize;
 
    unsigned int    m_initialSize;
 
    VERTEX*         m_vertices;
 
    // Status flags
    bool            m_failed;
    bool            m_dirty;
 
    static constexpr unsigned int DEFAULT_SIZE = 1048576;
};
} // namespace KIGFX
 
#endif /* VERTEX_CONTAINER_H_ */