Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
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;
129 
148 
150  virtual ~RenderingSurface();
151 
172  void addGeometryBuffer(const RenderQueueID queue,
173  const GeometryBuffer& buffer);
174 
186  void removeGeometryBuffer(const RenderQueueID queue,
187  const GeometryBuffer& buffer);
188 
201  void clearGeometry(const RenderQueueID queue);
202 
211  void clearGeometry();
212 
223  virtual void draw();
224 
237  virtual void invalidate();
238 
254  bool isInvalidated() const;
255 
265  virtual bool isRenderingWindow() const;
266 
289  virtual RenderingWindow& createRenderingWindow(TextureTarget& target);
290 
304  virtual void destroyRenderingWindow(RenderingWindow& window);
305 
307 
317  virtual void transferRenderingWindow(RenderingWindow& window);
318 
328  const RenderTarget& getRenderTarget() const;
329  RenderTarget& getRenderTarget();
330 
331 protected:
333  void draw(const RenderQueue& queue, RenderQueueEventArgs& args);
334 
336  void detatchWindow(RenderingWindow& w);
337 
339  void attachWindow(RenderingWindow& w);
340 
342  typedef std::map<RenderQueueID, RenderQueue> RenderQueueList;
344  typedef std::vector<RenderingWindow*> RenderingWindowList;
353 };
354 
355 } // End of CEGUI namespace section
356 
357 #if defined(_MSC_VER)
358 # pragma warning(pop)
359 #endif
360 
361 #endif // end of guard _CEGUIRenderingSurface_h_
Queue for overlay rendering that appears above other regular rendering.
Definition: CEGUIRenderingSurface.h:62
EventArgs based class that is passed to handlers subcribed to hear about begin/end events on renderin...
Definition: CEGUIRenderingSurface.h:74
static const String EventRenderQueueStarted
Definition: CEGUIRenderingSurface.h:121
Base class used as the argument to all subscribers Event object.
Definition: CEGUIEventArgs.h:52
Queue for base level rendering by the surface owner.
Definition: CEGUIRenderingSurface.h:53
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: CEGUIGeometryBuffer.h:42
RenderQueueID
Enumerated type for valid render queue IDs.
Definition: CEGUIRenderingSurface.h:46
Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...
Definition: CEGUITextureTarget.h:41
bool d_invalidated
holds invalidated state of target (as far as we are concerned)
Definition: CEGUIRenderingSurface.h:352
static const String EventRenderQueueEnded
Definition: CEGUIRenderingSurface.h:128
RenderingWindow is a RenderingSurface that can be &quot;drawn back&quot; onto another RenderingSurface and is p...
Definition: CEGUIRenderingWindow.h:44
static const String EventNamespace
Namespace for global events from RenderingSurface objects.
Definition: CEGUIRenderingSurface.h:113
Queue for second level of &#39;content&#39; rendering.
Definition: CEGUIRenderingSurface.h:59
RenderTarget & d_target
RenderTarget that this surface actually draws to.
Definition: CEGUIRenderingSurface.h:350
Queue for first level of &#39;content&#39; rendering.
Definition: CEGUIRenderingSurface.h:56
RenderQueueList d_queues
the collection of RenderQueue objects.
Definition: CEGUIRenderingSurface.h:346
Class that represents a surface that can have geometry based imagery drawn to it. ...
Definition: CEGUIRenderingSurface.h:109
Class that collects together a set of Event objects.
Definition: CEGUIEventSet.h:66
Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...
Definition: CEGUIRenderTarget.h:42
Queue for rendering that appears beneath base imagery.
Definition: CEGUIRenderingSurface.h:50
std::map< RenderQueueID, RenderQueue > RenderQueueList
collection type for the queues
Definition: CEGUIRenderingSurface.h:342
Class that represents a queue of GeometryBuffer objects to be rendered.
Definition: CEGUIRenderQueue.h:53
RenderingWindowList d_windows
collection of RenderingWindow object we own
Definition: CEGUIRenderingSurface.h:348
RenderQueueID queueID
ID of the queue that this event has been fired for.
Definition: CEGUIRenderingSurface.h:88
std::vector< RenderingWindow * > RenderingWindowList
collection type for created RenderingWindow objects
Definition: CEGUIRenderingSurface.h:344
String class used within the GUI system.
Definition: CEGUIString.h:57