VBO.h

Go to the documentation of this file.

/*

Copyright (c) 2017, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the Bangor University nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __VBO_h
#define __VBO_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef __gVirtualXRayConfig_h
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//==============================================================================
//==============================================================================
class VBO
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    VBO();
    
    
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    virtual ~VBO();
    
    
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    virtual void destroy();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void reset();
    
    
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    virtual void setVertexData(int aPrimitiveType,
            const unsigned int aNumberOfVertices = 0,
            unsigned int aNumberOfCompontentsPerVertex = 0,
            int aVertexDataType = 0,
            const void* apVertices = 0,
            const unsigned int aNumberOfNormals = 0,
            unsigned int aNumberOfCompontentsPerNormal = 0,
            int aNormalDataType = 0,
            const void* apNormals = 0,
            const unsigned int aNumberOfTextureCoordinates = 0,
            unsigned int aNumberOfCompontentsPerCoord = 0,
            int aCoordDataType = 0,
            const void* apTextureCoordinates = 0,
            const unsigned int aNumberOfAdditionalData = 0,
            unsigned int aNumberOfCompontentsPerAdditionalData = 0,
            int anAdditionalDataType = 0,
            const void* apAdditionalData = 0) = 0;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    virtual void setIndexData(const unsigned int aNumberOfIndexes,
                              int anIndexDataType,
                              const void* apIndexSet) = 0;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    virtual void display() const = 0;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    bool isReady() const;
    
    
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setBufferUsageHint(int aFlag);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    int getBufferUsageHint() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    int getPrimitiveType() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    virtual VBO& operator=(const VBO& aVbo);

    
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    unsigned int getOpenglMajorVersion() const;


//******************************************************************************
protected:
    unsigned int m_id_set[5];


    unsigned int m_number_of_normals;


    unsigned int m_number_of_compontents_per_normal;


    unsigned int m_number_of_additional_data;


    unsigned int m_number_of_compontents_per_additional_data;


    unsigned int m_number_of_texture_coordinates;


    unsigned int m_number_of_compontents_per_texture_coord;


    unsigned int m_number_of_vertices;


    unsigned int m_number_of_compontents_per_vertex;


    unsigned int m_number_of_indices;


    unsigned int m_normal_size;


    unsigned int m_additional_data_size;


    unsigned int m_texture_coordinate_size;


    unsigned int m_vertex_size;


    unsigned int m_index_size;


    int m_normal_data_type;

    int m_additional_data_type;


    int m_texture_coordinate_data_type;


    int m_vertex_data_type;


    int m_index_data_type;


    int m_primitive_type;


    int m_storage_type;


    unsigned int m_opengl_major_version;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "VBO.inl"


#endif // __VBO_h