Crazy Eddie's GUI System  0.8.7
RenderingSurface.h
1 /***********************************************************************
2  created: Mon Jan 12 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 _CEGUIRenderingSurface_h_
28 #define _CEGUIRenderingSurface_h_
29 
30 #include "CEGUI/EventSet.h"
31 #include "CEGUI/EventArgs.h"
32 #include "CEGUI/RenderQueue.h"
33 
34 #if defined(_MSC_VER)
35 # pragma warning(push)
36 # pragma warning(disable : 4251)
37 #endif
38 
39 
40 // Start of CEGUI namespace section
41 namespace CEGUI
42 {
43 //----------------------------------------------------------------------------//
45 enum RenderQueueID
46 {
47  RQ_USER_0,
50  RQ_USER_1,
52  RQ_BASE,
53  RQ_USER_2,
56  RQ_USER_3,
59  RQ_USER_4,
61  RQ_OVERLAY,
62  RQ_USER_5
63 };
64 
65 //----------------------------------------------------------------------------//
66 
73 class CEGUIEXPORT RenderQueueEventArgs : public EventArgs
74 {
75 public:
84  RenderQueueEventArgs(const RenderQueueID id);
85 
87  RenderQueueID queueID;
88 };
89 
90 //----------------------------------------------------------------------------//
91 
108 class CEGUIEXPORT RenderingSurface :
109  public EventSet,
110  public AllocatedObject<RenderingSurface>
111 {
112 public:
114  static const String EventNamespace;
122  static const String EventRenderQueueStarted;
129  static const String EventRenderQueueEnded;
130 
149 
151  virtual ~RenderingSurface();
152 
173  void addGeometryBuffer(const RenderQueueID queue,
174  const GeometryBuffer& buffer);
175 
187  void removeGeometryBuffer(const RenderQueueID queue,
188  const GeometryBuffer& buffer);
189 
202  void clearGeometry(const RenderQueueID queue);
203 
212  void clearGeometry();
213 
224  virtual void draw();
225 
238  virtual void invalidate();
239 
255  bool isInvalidated() const;
256 
266  virtual bool isRenderingWindow() const;
267 
290  virtual RenderingWindow& createRenderingWindow(TextureTarget& target);
291 
305  virtual void destroyRenderingWindow(RenderingWindow& window);
306 
308 
318  virtual void transferRenderingWindow(RenderingWindow& window);
319 
329  const RenderTarget& getRenderTarget() const;
330  RenderTarget& getRenderTarget();
331 
332 protected:
336  virtual void drawContent();
337 
339  void draw(const RenderQueue& queue, RenderQueueEventArgs& args);
340 
342  void detatchWindow(RenderingWindow& w);
343 
345  void attachWindow(RenderingWindow& w);
346 
348  typedef std::map<RenderQueueID, RenderQueue
349  /*CEGUI_MAP_ALLOC(RenderQueueID, RenderQueue)*/> RenderQueueList;
351  typedef std::vector<RenderingWindow*
352  CEGUI_VECTOR_ALLOC(RenderingWindow*)> RenderingWindowList;
354  RenderQueueList d_queues;
356  RenderingWindowList d_windows;
358  RenderTarget* d_target;
360  bool d_invalidated;
361 };
362 
363 } // End of CEGUI namespace section
364 
365 #if defined(_MSC_VER)
366 # pragma warning(pop)
367 #endif
368 
369 #endif // end of guard _CEGUIRenderingSurface_h_
CEGUI::GeometryBuffer
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:66
CEGUI::RQ_BASE
@ RQ_BASE
Queue for base level rendering by the surface owner.
Definition: RenderingSurface.h:100
CEGUI::RenderQueue
Class that represents a queue of GeometryBuffer objects to be rendered.
Definition: RenderQueue.h:76
CEGUI::RenderingSurface
Class that represents a surface that can have geometry based imagery drawn to it.
Definition: RenderingSurface.h:132
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::EventSet
Interface providing event signaling and handling.
Definition: EventSet.h:192
CEGUI::AllocatedObject
Definition: MemoryAllocatedObject.h:135
CEGUI::RenderingWindow
RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...
Definition: RenderingWindow.h:74
CEGUI::RQ_CONTENT_1
@ RQ_CONTENT_1
Queue for first level of 'content' rendering.
Definition: RenderingSurface.h:103
CEGUI::RenderQueueEventArgs
EventArgs based class that is passed to handlers subcribed to hear about begin/end events on renderin...
Definition: RenderingSurface.h:97
CEGUI::RenderTarget
Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...
Definition: RenderTarget.h:81
CEGUI::RQ_CONTENT_2
@ RQ_CONTENT_2
Queue for second level of 'content' rendering.
Definition: RenderingSurface.h:106
CEGUI::TextureTarget
Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...
Definition: TextureTarget.h:64
CEGUI::String
String class used within the GUI system.
Definition: String.h:88
CEGUI::RQ_OVERLAY
@ RQ_OVERLAY
Queue for overlay rendering that appears above other regular rendering.
Definition: RenderingSurface.h:109
CEGUI::RenderQueueID
RenderQueueID
Enumerated type for valid render queue IDs.
Definition: RenderingSurface.h:69
CEGUI::RQ_UNDERLAY
@ RQ_UNDERLAY
Queue for rendering that appears beneath base imagery.
Definition: RenderingSurface.h:97