RendererModules/Ogre/Renderer.h

/***********************************************************************
    created:    Tue Feb 17 2009
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2013 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 "../../Renderer.h"
#include "../../Size.h"
#include "../../Vector.h"
#include "CEGUI/Config.h"

#include <vector>

#if (defined( __WIN32__ ) || defined( _WIN32 )) && !defined(CEGUI_STATIC)
#   ifdef CEGUIOGRERENDERER_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;
class RenderTarget;
#if (CEGUI_OGRE_VERSION < ((1 << 16) | (9 << 8) | 0))
class TexturePtr;
#else
template<typename T> class SharedPtr;
class Texture;
typedef SharedPtr<Texture> TexturePtr;
#endif
class Matrix4;
}

#if (CEGUI_OGRE_VERSION >= (2 << 16))
// The new Ogre Compositor2 system has to be used since ViewPorts 
// no longer have the required functionality
#define CEGUI_USE_OGRE_COMPOSITOR2
#endif

#if (CEGUI_OGRE_VERSION >= ((2 << 16) | (1 << 8) | 0))
// The HLMS has to be used since fixed pipeline is disabled
#define CEGUI_USE_OGRE_HLMS
#include <OgreRenderOperation.h>
#include <OgreHlmsSamplerblock.h>
#endif

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

class OGRE_GUIRENDERER_API OgreRenderer : public Renderer
{
public:
#if !defined(CEGUI_USE_OGRE_COMPOSITOR2)

    static OgreRenderer& bootstrapSystem(const int abi = CEGUI_VERSION_ABI);
#endif

    static OgreRenderer& bootstrapSystem(Ogre::RenderTarget& target,
                                         const int abi = CEGUI_VERSION_ABI);

    static void destroySystem();

#if !defined(CEGUI_USE_OGRE_COMPOSITOR2)

    static OgreRenderer& create(const int abi = CEGUI_VERSION_ABI);
#endif

    static OgreRenderer& create(Ogre::RenderTarget& target,
                                const int abi = CEGUI_VERSION_ABI);

    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(const String& name, 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);

    bool isUsingShaders() const;

    void setUsingShaders(const bool use_shaders);

    void bindShaders();

    void updateShaderParams() const;

    void setWorldMatrix(const Ogre::Matrix4& m);
    void setViewMatrix(const Ogre::Matrix4& m);
    void setProjectionMatrix(const Ogre::Matrix4& m);
    const Ogre::Matrix4& getWorldMatrix() const;
    const Ogre::Matrix4& getViewMatrix() const;
    const Ogre::Matrix4& getProjectionMatrix() const;

    const Ogre::Matrix4& getWorldViewProjMatrix() const;
    
    bool isTexCoordSystemFlipped() const { return false; }

#ifdef CEGUI_USE_OGRE_HLMS
    Ogre::RenderTarget* getOgreRenderTarget();
    const Ogre::HlmsSamplerblock* getHlmsSamplerblock();
#endif

    // implement CEGUI::Renderer interface
    RenderTarget& getDefaultRenderTarget();
    GeometryBuffer& createGeometryBuffer();
    void destroyGeometryBuffer(const GeometryBuffer& buffer);
    void destroyAllGeometryBuffers();
    TextureTarget* createTextureTarget();
    void destroyTextureTarget(TextureTarget* target);
    void destroyAllTextureTargets();
    Texture& createTexture(const String& name);
    Texture& createTexture(const String& name,
                           const String& filename,
                           const String& resourceGroup);
    Texture& createTexture(const String& name, const Sizef& size);
    void destroyTexture(Texture& texture);
    void destroyTexture(const String& name);
    void destroyAllTextures();
    Texture& getTexture(const String& name) const;
    bool isTextureDefined(const String& name) const;
    void beginRendering();
    void endRendering();
    void setDisplaySize(const Sizef& sz);
    const Sizef& getDisplaySize() const;
    const Vector2f& getDisplayDPI() const;
    uint getMaxTextureSize() const;
    const String& getIdentifierString() const;

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

    void checkOgreInitialised();
    void throwIfNameExists(const String& name) const;
    static void logTextureCreation(const String& name);
    static void logTextureDestruction(const String& name);

    void constructor_impl(Ogre::RenderTarget& target);
    void initialiseShaders();
    void cleanupShaders();

    OgreRenderer_impl* d_pimpl;
};


} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIOgreRenderer_h_