gls_display_list.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsDisplayList class.

  \par Copyright Information

  Copyright (c) 2017 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.

*/
#ifndef _GLS_DISPLAY_LIST_H
#define _GLS_DISPLAY_LIST_H
#include "display.h"

namespace disti
{
/**
  The GlsDisplayList class.  Manages an OpenGL display list.
*/

class GlsDisplayList
{
protected:
    bool         _valid;   /**< True if this list is valid */
    bool         _useList; /**< True if this list is enabled */
    unsigned int _handle;  /**< The OpenGL list handle for this list */

public:
    GlsDisplayList( void )
        : _valid( false )
        , _useList( true )
        , _handle( 0 )
    {
    }

    GlsDisplayList& operator=( const GlsDisplayList& oldClass )
    {
        _useList = oldClass._useList;
        _valid   = false;
        _handle  = 0;

        return *this;
    }

    ~GlsDisplayList( void )
    {
        Invalidate();
    }

    /** Invalidate the display list.  An object with an invalid display list should
      * reinvoke its draw code to rebuild the display list.  Also deallocates the OpenGL list.
      */
    void Invalidate( void )
    {
        if( _valid )
        {
            glDeleteLists( _handle, 1 );
            _valid  = false;
            _handle = 0;
        }
    }

    /** Allocate an OpenGL display list, deallocating any existing list  */
    void Allocate( void )
    {
        Invalidate();
        _handle = glGenLists( 1 );
        _valid  = true;
    }

    /** Start writing into the display list */
    void Start( void ) { glNewList( _handle, GL_COMPILE ); }

    /** Stop writing into the display list and save it */
    void End( void ) { glEndList(); }

    /** Draw what's in the display list */
    void Invoke( void ) { glCallList( _handle ); }

    /** Returns true if the list is valid */
    bool Valid( void ) { return _valid; }

    /** Set wether or not the list is valid.  Be careful when 
      * setting this to true.  Make sure the list really is valid
      */
    void Valid( const bool& val ) { _valid = val; }

    /** Returns true if this display list is enabled */
    bool UseList( void ) { return _useList; }

    /** Set whether or not this display list is enabled */
    void UseList( const bool& val ) { _useList = val; }
};

} // namespace disti

#endif