GeometryBuffer.h

/***********************************************************************
    created:    Thu Jan 8 2009
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2010 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 _CEGUIGeometryBuffer_h_
#define _CEGUIGeometryBuffer_h_

#include "CEGUI/Base.h"
#include "CEGUI/Renderer.h"
#include "CEGUI/Rect.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT GeometryBuffer :
    public AllocatedObject<GeometryBuffer>
{
public:
    virtual ~GeometryBuffer();

    virtual void draw() const = 0;

    virtual void setTranslation(const Vector3f& v) = 0;

    virtual void setRotation(const Quaternion& r) = 0;

    virtual void setPivot(const Vector3f& p) = 0;

    virtual void setClippingRegion(const Rectf& region) = 0;

    virtual void appendVertex(const Vertex& vertex) = 0;

    virtual void appendGeometry(const Vertex* const vbuff, uint vertex_count)=0;

    virtual void setActiveTexture(Texture* texture) = 0;

    virtual void reset() = 0;

    virtual Texture* getActiveTexture() const = 0;

    virtual uint getVertexCount() const = 0;

    virtual uint getBatchCount() const = 0;

    virtual void setRenderEffect(RenderEffect* effect) = 0;

    virtual RenderEffect* getRenderEffect() = 0;

    virtual void setBlendMode(const BlendMode mode);

    virtual BlendMode getBlendMode() const;

    virtual void setClippingActive(const bool active) = 0;

    /*
    \brief
        Return whether clipping will be used for the current batch
        of vertices being defined.

    \return
        - true if vertices subsequently added to the GeometryBuffer will
          be clipped to the clipping region defined for this GeometryBuffer.
        - false if vertices subsequently added will not be clippled (other than
          to the edges of the rendering target).
    */
    virtual bool isClippingActive() const = 0;

protected:
    GeometryBuffer();

    BlendMode d_blendMode;
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIGeometryBuffer_h_