Crazy Eddie's GUI System  0.8.7
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
36 namespace CEGUI
37 {
39 template <typename T = RenderTarget>
40 class OGRE_GUIRENDERER_API OgreRenderTarget : public T
41 {
42 public:
44  OgreRenderTarget(OgreRenderer& owner, Ogre::RenderSystem& rs);
45 
47  virtual ~OgreRenderTarget();
48 
49 #if !defined(CEGUI_USE_OGRE_COMPOSITOR2)
50 
63  void setOgreViewportDimensions(const Rectf& area);
64 #endif
65 
66  // implement parts of CEGUI::RenderTarget interface
67  void draw(const GeometryBuffer& buffer);
68  void draw(const RenderQueue& queue);
69  void setArea(const Rectf& area);
70  const Rectf& getArea() const;
71  void activate();
72  void deactivate();
73  void unprojectPoint(const GeometryBuffer& buff,
74  const Vector2f& p_in, Vector2f& p_out) const;
75 
76 protected:
78  void updateMatrix() const;
80  void updateViewport();
81 #if !defined(CEGUI_USE_OGRE_COMPOSITOR2)
82  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 
97  bool d_renderTargetUpdated;
98 
99 #else
100  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)
115  Rectf d_ogreViewportDimensions;
117 #endif
118 };
119 
120 } // End of CEGUI namespace section
121 
122 #endif // end of guard _CEGUIOgreRenderTarget_h_
CEGUI::Renderer implementation for the Ogre engine.
Definition: RendererModules/Ogre/Renderer.h:91
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
Ogre::RenderSystem & d_renderSystem
Ogre RendererSystem used to affect the rendering process.
Definition: RendererModules/Ogre/RenderTarget.h:89
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:42
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
OgreRenderer & d_owner
OgreRenderer object that owns this RenderTarget.
Definition: RendererModules/Ogre/RenderTarget.h:87
bool d_matrixValid
true when d_matrix is valid and up to date
Definition: RendererModules/Ogre/RenderTarget.h:107
Rectf d_area
holds defined area for the RenderTarget
Definition: RendererModules/Ogre/RenderTarget.h:91
bool d_viewportValid
Definition: RendererModules/Ogre/RenderTarget.h:113
Ogre::RenderTarget * d_renderTarget
Ogre render target that we are effectively wrapping.
Definition: RendererModules/Ogre/RenderTarget.h:93
Class that represents a queue of GeometryBuffer objects to be rendered.
Definition: RenderQueue.h:52
Intermediate RenderTarget implementing common parts for Ogre engine.
Definition: RendererModules/Ogre/RenderTarget.h:40