gls_texture_palette.h

Go to the documentation of this file.

#ifndef _GLS_TEXTURE_PALETTE_H
#define _GLS_TEXTURE_PALETTE_H

/*! \file gls_texture_palette.h
\brief  This header defines the GlsTexturePalette class used in
        the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/

#include "gls_include.h"
#include "gls_state_manager.h"
#include "gls_pointer_array.h"
#include "gls_image.h"
#include "gls_class_invariant.h"

/** Stores a list of textures, each with its own
  * texture handle.  This allows the textures to be stored separately from the
  * objects, which allows multiple objects to share the same textures.
  * \invariant _imagePointers.Invariant(), invariant of each image in the arrray
  */
class GlsTexturePalette
{
public:
    GLS_CLASS_INVARIANT_DECLARATION( GlsTexturePalette )

    /** intialization parameters for GlsTexturePalette */
    struct InitParameters
    {
        const GlsUInt32                     numInlineImages;  /**< number of inline images in inlineImages array */
        const GlsImage::InlineImage* const *inlineImages;     /**< array of inline images to be inserted in palette
                                                                * else GLS_NULL if numInlineImages == 0, array can contain
                                                                * GLS_NULL entries for empty texture palette slots */

        #if defined( GLS_DEBUG )
            /** Determine if the init parameters are valid ( GLS_DEBUG only )
              * \return GLS_TRUE if valid else GLS_FALSE
              * \pre none
              * \post none
              */
            GlsBool IsValid( void ) const;
        #endif // GLS_DEBUG
    };

    /** texture index used to indicate that an object does not have a texture */
    static const GlsUInt32 NO_TEXTURE = GLSUINT32_MAX;

    /** Create a new texture palette with the indicated number of entries
      * \param initParameters initialization parameters for texture palette
      * \pre initParameters.IsValid()
      * \post object constructed
      */
    GlsTexturePalette( const InitParameters& initParameters );

    /** Destructor - shall never be called
      * \pre none
      * \post none
      */
    virtual ~GlsTexturePalette();

    /** Bind the texture at the given index, unless it is already bound.  Set
      * as the texture to be used for texturing polygons
      * \param gl  OpenGL State Manager to bind texture in
      * \param index  index < GetSize(), index != NO_TEXTURE, entry at index is _not_ GLS_NULL
      * \pre index < GetSize(), index != NO_TEXTURE, entry at index is _not_ GLS_NULL
      * \post texture at given index is bound to OpenGL
      */
    void BindTexture( GlsStateManager &gl, const GlsUInt32 index ) const;

    #if defined( GLS_DEBUG )
        /** Get the number of entries in the texture palette ( GLS_DEBUG only )
          * \return number of entries in the texture palette
          * \pre none
          * \post none
          */
        GlsUInt32 GetSize( void ) const;
    #endif // GLS_DEBUG

protected:
    GlsPointerArray _imagePointers; /**< array of image pointers */

private:
    // Disable implicit generated Members
    GlsTexturePalette& operator=( const GlsTexturePalette &rhs );
    GlsTexturePalette( const GlsTexturePalette &src );
};

#endif // _GLS_TEXTURE_PALETTE_H