CEGUIRenderer.h

/***********************************************************************
        filename:       CEGUIRenderer.h
        created:        20/2/2004
        author:         Paul D Turner
        
        purpose:        Defines interface for abstract Renderer class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 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 _CEGUIRenderer_h_
#define _CEGUIRenderer_h_

#include "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUIRect.h"
#include "CEGUIColourRect.h"
#include "CEGUIEventSet.h"


// Start of CEGUI namespace section
namespace CEGUI
{
enum OrientationFlags {
        FlipHorizontal          = 1,    
        FlipVertical            = 2,    
        RotateRightAngle        = 4             
};

enum QuadSplitMode
{
        TopLeftToBottomRight,   
        BottomLeftToTopRight    
};


class CEGUIEXPORT Renderer : public EventSet
{
public:
        static const String EventNamespace;                             

        /*************************************************************************
                Event name constants
        *************************************************************************/
        static const String EventDisplaySizeChanged;


        /*************************************************************************
                Abstract interface methods
        *************************************************************************/
        virtual void    addQuad(const Rect& dest_rect, float z, const Texture* tex, const Rect& texture_rect, const ColourRect& colours, QuadSplitMode quad_split_mode) = 0;


        virtual void    doRender(void) = 0;


        virtual void    clearRenderList(void) = 0;


        virtual void    setQueueingEnabled(bool setting) = 0;


        virtual Texture*        createTexture(void) = 0;


        virtual Texture*        createTexture(const String& filename, const String& resourceGroup) = 0;


        virtual Texture*        createTexture(float size) = 0;


        virtual void            destroyTexture(Texture* texture) = 0;

        
        virtual void            destroyAllTextures(void) = 0;


        virtual bool    isQueueingEnabled(void) const = 0;


        virtual float   getWidth(void) const    = 0;


        virtual float   getHeight(void) const   = 0;


        virtual Size    getSize(void) const             = 0;


        virtual Rect    getRect(void) const             = 0;


        virtual uint    getMaxTextureSize(void) const   = 0;


        virtual uint    getHorzScreenDPI(void) const    = 0;


        virtual uint    getVertScreenDPI(void) const    = 0;


        /*************************************************************************
                Basic stuff we provide in base class
        *************************************************************************/
        void    resetZValue(void)                               {d_current_z = GuiZInitialValue;}


        void    advanceZValue(void)                             {d_current_z -= GuiZElementStep;}


        float   getCurrentZ(void) const                 {return d_current_z;}


        float   getZLayer(uint layer) const             {return d_current_z - ((float)layer * GuiZLayerStep);}


    const String& getIdentifierString() const;

    virtual ResourceProvider* createResourceProvider(void);

protected:
        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        Renderer(void);

public:         // for luabind support
        virtual ~Renderer(void);

private:
        /*************************************************************************
                Implementation constants
        *************************************************************************/
        static const float      GuiZInitialValue;               
        static const float      GuiZElementStep;                
        static const float      GuiZLayerStep;                  


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        float   d_current_z;            

protected:
    ResourceProvider* d_resourceProvider;      
    String d_identifierString;                 
};

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIRenderer_h_