kicad/include/gal/opengl/vbo_item.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 CERN
 * @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
 */

/**
 * @file vbo_item.h
 * @brief Class to handle an item held in a Vertex Buffer Object.
 */

#ifndef VBO_ITEM_H_
#define VBO_ITEM_H_

#include <GL/gl.h>
#include <gal/color4d.h>
#include <cstddef>

namespace KiGfx
{
typedef struct VBO_VERTEX
{
    GLfloat x, y, z;        // Coordinates
    GLubyte r, g, b, a;     // Color
    GLfloat shader[4];      // Shader type & params
} VBO_VERTEX;

class VBO_CONTAINER;

class VBO_ITEM
{
public:
    VBO_ITEM( VBO_CONTAINER* aContainer );
    ~VBO_ITEM();

    /**
     * Function PushVertex()
     * Adds a single vertex to the VBO_ITEM. Vertex contains information about coordinates and
     * colors and has to follow the specified format {X,Y,Z,R,G,B,A}.
     * @param aVertex is a vertex to be added.
     * @param aShader is an attribute for shader.
     */
    void PushVertex( const VBO_VERTEX* aVertex );

    /**
     * Function PushVertices()
     * Adds multiple vertices to the VBO_ITEM. This function is recommended over multiple calls to
     * PushVertex, as it does less memory reallocations. Vertices contain information about
     * coordinates and colors and has to follow the specified format {X,Y,Z,R,G,B,A}.
     * @param aVertices are vertices to be added.
     * @param aSize is an amount of vertices to be added.
     * @param aShader is an attribute for shader.
     */
    void PushVertices( const VBO_VERTEX* aVertices, GLuint aSize );

    /**
     * Function GetVertices()
     * Returns a pointer to the array containing all vertices.
     * @return Pointer to vertices packed in format {X, Y, Z, R, G, B, A}.
     */
    VBO_VERTEX* GetVertices();


    /**
     * Function GetSize()
     * Returns information about number of vertices stored.
     * @param Amount of vertices.
     */
    inline unsigned int GetSize() const
    {
        return m_size;
    }

    /**
     * Function SetOffset()
     * Sets data offset in the VBO.
     * @param aOffset is the offset expressed as a number of vertices.
     */
    inline void SetOffset( unsigned int aOffset )
    {
        m_offset = aOffset;
    }

    /**
     * Function GetOffset()
     * Returns data offset in the VBO.
     * @return Data offset expressed as a number of vertices.
     */
    inline unsigned int GetOffset() const
    {
        return m_offset;
    }

    /**
     * Function ChangeColor()
     * Colors all vertices to the specified color.
     * @param aColor is the new color for vertices.
     */
    void ChangeColor( const COLOR4D& aColor );

    /**
     * Function ChangeDepth()
     * Moves all vertices to the specified depth.
     * @param aDepth is the new depth for vertices.
     */
    void ChangeDepth( int aDepth );

    ///< Informs the container that there will be no more vertices for the current VBO_ITEM
    void Finish();

    ///< Data structure for vertices {X,Y,Z,R,G,B,A,shader&param} (@see VBO_VERTEX).
    static const unsigned int VertByteSize       = sizeof(VBO_VERTEX);
    static const unsigned int VertStride         = VertByteSize / sizeof(GLfloat);

    static const unsigned int CoordByteSize      = sizeof(VBO_VERTEX().x) + sizeof(VBO_VERTEX().y) +
                                                   sizeof(VBO_VERTEX().z);
    static const unsigned int CoordStride        = CoordByteSize / sizeof(GLfloat);

    // Offset of color data from the beginning of each vertex data
    static const unsigned int ColorByteOffset    = offsetof(VBO_VERTEX, r);
    static const unsigned int ColorOffset        = ColorByteOffset / sizeof(GLubyte);
    static const unsigned int ColorByteSize      = sizeof(VBO_VERTEX().r) + sizeof(VBO_VERTEX().g) +
                                                   sizeof(VBO_VERTEX().b) + sizeof(VBO_VERTEX().a);
    static const unsigned int ColorStride        = ColorByteSize / sizeof(GLubyte);

    // Shader attributes
    static const unsigned int ShaderByteOffset   = offsetof(VBO_VERTEX, shader);
    static const unsigned int ShaderOffset       = ShaderByteOffset / sizeof(GLfloat);
    static const unsigned int ShaderByteSize     = sizeof(VBO_VERTEX().shader);
    static const unsigned int ShaderStride       = ShaderByteSize / sizeof(GLfloat);

    static const unsigned int IndByteSize        = sizeof(GLuint);

private:
    ///< Offset and size of data stored in the VBO_CONTAINER.
    unsigned int    m_offset;
    unsigned int    m_size;

    ///< Storage for vertices.
    VBO_CONTAINER*  m_container;

    ///< Flag telling if the item should be recached in VBO or not.
    bool            m_isDirty;
};
} // namespace KiGfx

#endif /* VBO_ITEM_H_ */