gls_index_array.h

Go to the documentation of this file.

/*! \file
  \brief The disti::GlsIndexArray class, for managing index buffers.
 
  \par Copyright Information
 
 Copyright (c) 2016 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
 The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America. Use, distribution,
duplication, or disclosure by the U. S. Government is subject to
"Restricted Rights" as set forth in DFARS 252.227-7014(c)(1)(ii).
 
*/
 
#ifndef GLS_INDEX_ARRAY_H
#define GLS_INDEX_ARRAY_H
 
#include "gls_include.h"
#include "gls_state_manager.h"
#include "non_copyable.h"
 
namespace disti
{
/// \details The GlsIndexArray class. Wraps an OpenGL index buffer object.
class GlsIndexArray : public NonCopyable
{
public:
    /** Default constructor
     */
    GlsIndexArray();
 
    /** Destructor
     */
    virtual ~GlsIndexArray();
 
    /** Sets the size of the index buffer
     * \param size New index buffer count
     */
    void SetSize( const unsigned int size );
 
    /** \return Returns the size of the index buffer */
    unsigned int GetSize() const
    {
        return _size;
    }
 
    /** Populates the the index buffer
     * \pre _size > 0
     * \param indexData The indices to set.  The array length is assumed to be equal to GetSize()
     */
    void SetIndices( const unsigned short indexData[] );
 
    /** Sets one index
     * \pre index < _size
     * \param index The index of the index to set
     * \param value The index data
     */
    void SetIndex( const unsigned int index, const unsigned short value );
 
    /** Download the index buffer data to Open GL 
     * \pre (_vboHandle != 0) && (_size > 0) 
     * \param stateManager The OpenGL state to download the index buffer to
     */
    void Bake( IGlsStateManager* stateManager );
 
    /** Bind the index buffer, e.g. make it current
     * \pre (_vboHandle != 0) && (_size > 0)
     * \param stateManager The OpenGL state to bind the buffer on
     */
    void Bind( IGlsStateManager* stateManager );
 
protected:
    unsigned short* _indexData; /**< The memory for storing the indices */
    unsigned int    _vboHandle; /**< The OpenGL VBO handle */
    unsigned int    _size;      /**< The number of indices. There can be unsigned int quantity of unsigned short values*/
 
    /** Allocates the buffer data, copying the existing data
     * \param size The new size in bytes to allocate
     */
    void AllocateBuffer( const unsigned int size );
 
    /** Deallocates the buffer data
     */
    void DeallocateBuffer();
};
 
} // namespace disti
 
#endif