Crazy Eddie's GUI System  0.8.7
RenderTarget.h
1 /***********************************************************************
2  created: Sun Jan 11 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 _CEGUIRenderTarget_h_
28 #define _CEGUIRenderTarget_h_
29 
30 #include "CEGUI/Base.h"
31 #include "CEGUI/EventSet.h"
32 #include "CEGUI/EventArgs.h"
33 #include "CEGUI/Vector.h"
34 #include "CEGUI/Rect.h"
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
40 class CEGUIEXPORT RenderTargetEventArgs : public EventArgs
41 {
42 public:
44  target(target)
45  {}
46 
49 };
50 
57 class CEGUIEXPORT RenderTarget :
58  public EventSet,
59  public AllocatedObject<RenderTarget>
60 {
61 public:
63  static const String EventNamespace;
64 
69  static const String EventAreaChanged;
70 
80  virtual void draw(const GeometryBuffer& buffer) = 0;
81 
91  virtual void draw(const RenderQueue& queue) = 0;
92 
112  virtual void setArea(const Rectf& area) = 0;
113 
121  virtual const Rectf& getArea() const = 0;
122 
136  virtual bool isImageryCache() const = 0;
137 
147  virtual void activate() = 0;
148 
158  virtual void deactivate() = 0;
159 
165  virtual void unprojectPoint(const GeometryBuffer& buff,
166  const Vector2f& p_in, Vector2f& p_out) const = 0;
167 };
168 
169 } // End of CEGUI namespace section
170 
171 #endif // end of guard _CEGUIRenderTarget_h_
CEGUI::GeometryBuffer
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
CEGUI::RenderTarget::setArea
virtual void setArea(const Rectf &area)=0
Set the area for this RenderTarget. The exact action this function will take depends upon what the co...
CEGUI::RenderQueue
Class that represents a queue of GeometryBuffer objects to be rendered.
Definition: RenderQueue.h:54
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:167
CEGUI::RenderTarget::activate
virtual void activate()=0
Activate the render target and put it in a state ready to be drawn to.
CEGUI::RenderTargetEventArgs
EventArgs class passed to subscribers of RenderTarget events.
Definition: RenderTarget.h:41
CEGUI::AllocatedObject
Definition: MemoryAllocatedObject.h:110
CEGUI::Vector2< float >
CEGUI::RenderTarget::getArea
virtual const Rectf & getArea() const =0
Return the area defined for this RenderTarget.
CEGUI::RenderTarget::draw
virtual void draw(const RenderQueue &queue)=0
Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents.
CEGUI::RenderTarget::EventNamespace
static const String EventNamespace
Namespace for global events.
Definition: RenderTarget.h:63
CEGUI::RenderTarget
Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...
Definition: RenderTarget.h:60
CEGUI::RenderTarget::EventAreaChanged
static const String EventAreaChanged
Definition: RenderTarget.h:69
CEGUI::RenderTarget::isImageryCache
virtual bool isImageryCache() const =0
Return whether the RenderTarget is an implementation that caches actual rendered imagery.
CEGUI::String
String class used within the GUI system.
Definition: String.h:64
CEGUI::RenderTargetEventArgs::target
RenderTarget * target
pointer to the RenderTarget that triggered the event.
Definition: RenderTarget.h:48
CEGUI::RenderTarget::draw
virtual void draw(const GeometryBuffer &buffer)=0
Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents.
CEGUI::RenderTarget::unprojectPoint
virtual void unprojectPoint(const GeometryBuffer &buff, const Vector2f &p_in, Vector2f &p_out) const =0
Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer ...
CEGUI::Rect< float >
CEGUI::RenderTarget::deactivate
virtual void deactivate()=0
Deactivate the render target after having completed rendering.
CEGUI::EventArgs
Base class used as the argument to all subscribers Event object.
Definition: EventArgs.h:51