Crazy Eddie's GUI System 0.8.7
Loading...
Searching...
No Matches
RendererModules/Ogre/RenderTarget.h
1/***********************************************************************
2 created: Tue Feb 17 2009
3 author: Paul D Turner
4*************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 ***************************************************************************/
27#ifndef _CEGUIOgreRenderTarget_h_
28#define _CEGUIOgreRenderTarget_h_
29
30#include "../../RenderTarget.h"
31#include "CEGUI/RendererModules/Ogre/Renderer.h"
32#include "../../Rect.h"
33#include <OgreMatrix4.h>
34
35// Start of CEGUI namespace section
36namespace CEGUI
37{
39template <typename T = RenderTarget>
40class OGRE_GUIRENDERER_API OgreRenderTarget : public T
41{
42public:
44 OgreRenderTarget(OgreRenderer& owner, Ogre::RenderSystem& rs);
45
48
49#if !defined(CEGUI_USE_OGRE_COMPOSITOR2)
64#endif
65
66 // implement parts of CEGUI::RenderTarget interface
68 void draw(const RenderQueue& queue);
69 void setArea(const Rectf& area);
70 const Rectf& getArea() const;
71 void activate();
72 void deactivate();
74 const Vector2f& p_in, Vector2f& p_out) const;
75
76protected:
78 void updateMatrix() const;
81#if !defined(CEGUI_USE_OGRE_COMPOSITOR2)
83 void updateOgreViewportDimensions(const Ogre::RenderTarget* const rt);
84#endif
85
89 Ogre::RenderSystem& d_renderSystem;
93 Ogre::RenderTarget* d_renderTarget;
94#ifdef CEGUI_USE_OGRE_COMPOSITOR2
95
98
99#else
101 Ogre::Viewport* d_viewport;
102#endif // CEGUI_USE_OGRE_COMPOSITOR2
103
105 mutable Ogre::Matrix4 d_matrix;
107 mutable bool d_matrixValid;
109 mutable float d_viewDistance;
114#if !defined(CEGUI_USE_OGRE_COMPOSITOR2)
117#endif
118};
119
120} // End of CEGUI namespace section
121
122#endif // end of guard _CEGUIOgreRenderTarget_h_
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition GeometryBuffer.h:44
Intermediate RenderTarget implementing common parts for Ogre engine.
Definition RendererModules/Ogre/RenderTarget.h:41
Rectf d_ogreViewportDimensions
holds set Ogre viewport dimensions
Definition RendererModules/Ogre/RenderTarget.h:116
void activate()
Activate the render target and put it in a state ready to be drawn to.
float d_viewDistance
tracks viewing distance (this is set up at the same time as d_matrix)
Definition RendererModules/Ogre/RenderTarget.h:109
Ogre::Matrix4 d_matrix
projection / view matrix cache
Definition RendererModules/Ogre/RenderTarget.h:105
Rectf d_area
holds defined area for the RenderTarget
Definition RendererModules/Ogre/RenderTarget.h:91
Ogre::RenderTarget * d_renderTarget
Ogre render target that we are effectively wrapping.
Definition RendererModules/Ogre/RenderTarget.h:93
void updateMatrix() const
helper that initialises the cached matrix
virtual ~OgreRenderTarget()
Destructor.
void deactivate()
Deactivate the render target after having completed rendering.
Ogre::Viewport * d_viewport
Ogre viewport used for this target.
Definition RendererModules/Ogre/RenderTarget.h:101
void unprojectPoint(const GeometryBuffer &buff, const Vector2f &p_in, Vector2f &p_out) const
Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer ...
bool d_matrixValid
true when d_matrix is valid and up to date
Definition RendererModules/Ogre/RenderTarget.h:107
void setOgreViewportDimensions(const Rectf &area)
Set the underlying viewport area directly - bypassing what the RenderTarget considers to be it's area...
void updateOgreViewportDimensions(const Ogre::RenderTarget *const rt)
helper to update the actual Ogre viewport dimensions
const Rectf & getArea() const
Return the area defined for this RenderTarget.
void draw(const RenderQueue &queue)
Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents.
OgreRenderer & d_owner
OgreRenderer object that owns this RenderTarget.
Definition RendererModules/Ogre/RenderTarget.h:87
Ogre::RenderSystem & d_renderSystem
Ogre RendererSystem used to affect the rendering process.
Definition RendererModules/Ogre/RenderTarget.h:89
void setArea(const Rectf &area)
Set the area for this RenderTarget. The exact action this function will take depends upon what the co...
bool d_viewportValid
Definition RendererModules/Ogre/RenderTarget.h:113
void draw(const GeometryBuffer &buffer)
Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents.
OgreRenderTarget(OgreRenderer &owner, Ogre::RenderSystem &rs)
Constructor.
void updateViewport()
helper that initialises the viewport
CEGUI::Renderer implementation for the Ogre engine.
Definition RendererModules/Ogre/Renderer.h:92
Class that represents a queue of GeometryBuffer objects to be rendered.
Definition RenderQueue.h:54
base class for properties able to do native set/get
Definition TypedProperty.h:50
Main namespace for Crazy Eddie's GUI Library.
Definition arch_overview.dox:1