/***********************************************************************
    filename:   CEGUIRenderQueue.h
    created:    Fri Jan 9 2009
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIRenderQueue_h_
#define _CEGUIRenderQueue_h_

#include "CEGUIBase.h"
#include <vector>

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
    Class that represents a queue of GeometryBuffer objects to be rendered.

\note
    The RenderQueue does not make copies of added GeometryBuffers, nor does it
    take ownership of them - it is up to other parts of the system to manage the
    lifetime of the GeometryBuffer objects (and to remove them from any
    RenderQueue to which they may be attached prior to destoying them).
*/
class CEGUIEXPORT RenderQueue
{
public:
    /*!
    \brief
        Draw all GeometryBuffer objects currently listed in the RenderQueue.
        The GeometryBuffer objects remain in the queue after drawing has taken
        place.
    */
    void draw() const;

    /*!
    \brief
        Add a GeometryBuffer to the RenderQueue.  Ownership of the
        GeometryBuffer does not pass to the RenderQueue.

    \param buffer
        GeometryBuffer that is to be added to the RenderQueue for later drawing.
    */
    void addGeometryBuffer(const GeometryBuffer& buffer);

    /*!
    \brief
        Remove a GeometryBuffer previously queued for drawing.  If the specified
        GeometryBuffer is not added to the queue, no action is taken.  The
        removed GeometryBuffer is not destroyed or modified in any way.

    \param buffer
        GeometryBuffer to be removed from the queue.
    */
    void removeGeometryBuffer(const GeometryBuffer& buffer);

    /*!
    \brief
        Remove any and all queued GeometryBuffer objects and restore the queue
        to the default state.  Any GeometryBuffer objects removed are not
        destroyed or modified in any way.
    */
    void reset();

private:
    //! Type to use for the GeometryBuffer collection.
    typedef std::vector<const GeometryBuffer*> BufferList;
    //! Collection of GeometryBuffer objects that comprise this RenderQueue.
    BufferList d_buffers;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif

#endif  // end of guard _CEGUIRenderQueue_h_
