CEGUIRenderingSurface.h

/***********************************************************************
    filename:   CEGUIRenderingSurface.h
    created:    Mon Jan 12 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 _CEGUIRenderingSurface_h_
#define _CEGUIRenderingSurface_h_

#include "CEGUIEventSet.h"
#include "CEGUIEventArgs.h"
#include "CEGUIRenderQueue.h"

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


// Start of CEGUI namespace section
namespace CEGUI
{
//----------------------------------------------------------------------------//
enum RenderQueueID
{
    RQ_USER_0,
    RQ_UNDERLAY,
    RQ_USER_1,
    RQ_BASE,
    RQ_USER_2,
    RQ_CONTENT_1,
    RQ_USER_3,
    RQ_CONTENT_2,
    RQ_USER_4,
    RQ_OVERLAY,
    RQ_USER_5
};

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

class CEGUIEXPORT RenderQueueEventArgs : public EventArgs
{
public:
    RenderQueueEventArgs(const RenderQueueID id);

    RenderQueueID queueID;
};

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

class CEGUIEXPORT RenderingSurface : public EventSet
{
public:
    static const String EventNamespace;
    static const String EventRenderQueueStarted;
    static const String EventRenderQueueEnded;

    RenderingSurface(RenderTarget& target);

    virtual ~RenderingSurface();

    void addGeometryBuffer(const RenderQueueID queue,
                           const GeometryBuffer& buffer);

    void removeGeometryBuffer(const RenderQueueID queue,
                              const GeometryBuffer& buffer);

    void clearGeometry(const RenderQueueID queue);

    void clearGeometry();

    virtual void draw();

    virtual void invalidate();

    bool isInvalidated() const;

    virtual bool isRenderingWindow() const;

    virtual RenderingWindow& createRenderingWindow(TextureTarget& target);

    virtual void destroyRenderingWindow(RenderingWindow& window);


    virtual void transferRenderingWindow(RenderingWindow& window);

    const RenderTarget& getRenderTarget() const;
    RenderTarget& getRenderTarget();

protected:
    void draw(const RenderQueue& queue, RenderQueueEventArgs& args);

    void detatchWindow(RenderingWindow& w);

    void attachWindow(RenderingWindow& w);

    typedef std::map<RenderQueueID, RenderQueue> RenderQueueList;
    typedef std::vector<RenderingWindow*> RenderingWindowList;
    RenderQueueList d_queues;
    RenderingWindowList d_windows;
    RenderTarget& d_target;
    bool d_invalidated;
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIRenderingSurface_h_