Crazy Eddies GUI System  0.7.0
CEGUIRenderingSurface.h
1 /***********************************************************************
2  filename: CEGUIRenderingSurface.h
3  created: Mon Jan 12 2009
4  author: Paul D Turner
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIRenderingSurface_h_
29 #define _CEGUIRenderingSurface_h_
30 
31 #include "CEGUIEventSet.h"
32 #include "CEGUIEventArgs.h"
33 #include "CEGUIRenderQueue.h"
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 
41 // Start of CEGUI namespace section
42 namespace CEGUI
43 {
44 //----------------------------------------------------------------------------//
47 {
48  RQ_USER_0,
51  RQ_USER_1,
54  RQ_USER_2,
57  RQ_USER_3,
60  RQ_USER_4,
63  RQ_USER_5
64 };
65 
66 //----------------------------------------------------------------------------//
67 
74 class CEGUIEXPORT RenderQueueEventArgs : public EventArgs
75 {
76 public:
86 
89 };
90 
91 //----------------------------------------------------------------------------//
92 
109 class CEGUIEXPORT RenderingSurface : public EventSet
110 {
111 public:
113  static const String EventNamespace;
118 
137 
139  virtual ~RenderingSurface();
140 
161  void addGeometryBuffer(const RenderQueueID queue,
162  const GeometryBuffer& buffer);
163 
175  void removeGeometryBuffer(const RenderQueueID queue,
176  const GeometryBuffer& buffer);
177 
190  void clearGeometry(const RenderQueueID queue);
191 
200  void clearGeometry();
201 
212  virtual void draw();
213 
226  virtual void invalidate();
227 
243  bool isInvalidated() const;
244 
254  virtual bool isRenderingWindow() const;
255 
278  virtual RenderingWindow& createRenderingWindow(TextureTarget& target);
279 
293  virtual void destroyRenderingWindow(RenderingWindow& window);
294 
296 
306  virtual void transferRenderingWindow(RenderingWindow& window);
307 
317  const RenderTarget& getRenderTarget() const;
318  RenderTarget& getRenderTarget();
319 
320 protected:
322  void draw(const RenderQueue& queue, RenderQueueEventArgs& args);
323 
325  void detatchWindow(RenderingWindow& w);
326 
328  void attachWindow(RenderingWindow& w);
329 
331  typedef std::map<RenderQueueID, RenderQueue> RenderQueueList;
333  typedef std::vector<RenderingWindow*> RenderingWindowList;
342 };
343 
344 } // End of CEGUI namespace section
345 
346 #if defined(_MSC_VER)
347 # pragma warning(pop)
348 #endif
349 
350 #endif // end of guard _CEGUIRenderingSurface_h_