CEGUIOgreRenderer.h

/***********************************************************************
    filename:   CEGUIOgreRenderer.h
    created:    Tue Feb 17 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 _CEGUIOgreRenderer_h_
#define _CEGUIOgreRenderer_h_

#include "../../CEGUIRenderer.h"
#include "../../CEGUISize.h"
#include "../../CEGUIVector.h"

#include <OgreBlendMode.h>
#include <OgreTextureUnitState.h>

#include <vector>

#if (defined( __WIN32__ ) || defined( _WIN32 )) && !defined(CEGUI_STATIC)
#   ifdef OGRE_GUIRENDERER_EXPORTS
#       define OGRE_GUIRENDERER_API __declspec(dllexport)
#   else
#       define OGRE_GUIRENDERER_API __declspec(dllimport)
#   endif
#else
#   define OGRE_GUIRENDERER_API
#endif

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

namespace Ogre
{
class Root;
class RenderSystem;
}

// Start of CEGUI namespace section
namespace CEGUI
{
class OgreGeometryBuffer;
class OgreTexture;
class OgreResourceProvider;
class OgreImageCodec;
class OgreWindowTarget;

class OGRE_GUIRENDERER_API OgreRenderer : public Renderer
{
public:
    static OgreRenderer& bootstrapSystem();

    static OgreRenderer& bootstrapSystem(Ogre::RenderTarget& target);

    static void destroySystem();

    static OgreRenderer& create();

    static OgreRenderer& create(Ogre::RenderTarget& target);

    static void destroy(OgreRenderer& renderer);

    static OgreResourceProvider& createOgreResourceProvider();

    static void destroyOgreResourceProvider(OgreResourceProvider& rp);

    static OgreImageCodec& createOgreImageCodec();

    static void destroyOgreImageCodec(OgreImageCodec& ic);

    void setRenderingEnabled(const bool enabled);

    bool isRenderingEnabled() const;

    Texture& createTexture(Ogre::TexturePtr& tex, bool take_ownership = false);

    void setupRenderingBlendMode(const BlendMode mode,
                                 const bool force = false);

    void setFrameControlExecutionEnabled(const bool enabled);

    bool isFrameControlExecutionEnabled() const;

    void initialiseRenderStateSettings();

    void setDefaultRootRenderTarget(Ogre::RenderTarget& target);

    // implement CEGUI::Renderer interface
    RenderingRoot& getDefaultRenderingRoot();
    GeometryBuffer& createGeometryBuffer();
    void destroyGeometryBuffer(const GeometryBuffer& buffer);
    void destroyAllGeometryBuffers();
    TextureTarget* createTextureTarget();
    void destroyTextureTarget(TextureTarget* target);
    void destroyAllTextureTargets();
    Texture& createTexture();
    Texture& createTexture(const String& filename, const String& resourceGroup);
    Texture& createTexture(const Size& size);
    void destroyTexture(Texture& texture);
    void destroyAllTextures();
    void beginRendering();
    void endRendering();
    void setDisplaySize(const Size& sz);
    const Size& getDisplaySize() const;
    const Vector2& getDisplayDPI() const;
    uint getMaxTextureSize() const;
    const String& getIdentifierString() const;

protected:
    OgreRenderer();
    OgreRenderer(Ogre::RenderTarget& target);
    virtual ~OgreRenderer();

    void checkOgreInitialised();

    void constructor_impl(Ogre::RenderTarget& target);

    static String d_rendererID;
    Size d_displaySize;
    Vector2 d_displayDPI;
    RenderingRoot* d_defaultRoot;
    OgreWindowTarget* d_defaultTarget;
    typedef std::vector<TextureTarget*> TextureTargetList;
    TextureTargetList d_textureTargets;
    typedef std::vector<OgreGeometryBuffer*> GeometryBufferList;
    GeometryBufferList d_geometryBuffers;
    typedef std::vector<OgreTexture*> TextureList;
    TextureList d_textures;
    uint d_maxTextureSize;
    Ogre::Root* d_ogreRoot;
    Ogre::RenderSystem* d_renderSystem;
    BlendMode d_activeBlendMode;
    bool d_makeFrameControlCalls;
};


} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIOgreRenderer_h_