Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUIRenderingWindow.h
1 /***********************************************************************
2  filename: CEGUIRenderingWindow.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 _CEGUIRenderingWindow_h_
29 #define _CEGUIRenderingWindow_h_
30 
31 #include "CEGUIRenderingSurface.h"
32 #include "CEGUIVector.h"
33 #include "CEGUISize.h"
34 
35 // Start of CEGUI namespace section
36 namespace CEGUI
37 {
44 class CEGUIEXPORT RenderingWindow : public RenderingSurface
45 {
46 public:
65 
67  ~RenderingWindow();
68 
88  void setClippingRegion(const Rect& region);
89 
104  void setPosition(const Vector2& position);
105 
114  void setSize(const Size& size);
115 
125  void setRotation(const Vector3& rotation);
126 
136  void setPivot(const Vector3& pivot);
137 
151  const Vector2& getPosition() const;
152 
160  const Size& getSize() const;
161 
170  const Vector3& getRotation()const;
171 
180  const Vector3& getPivot() const;
181 
192  const TextureTarget& getTextureTarget() const;
193  TextureTarget& getTextureTarget();
194 
207  void update(const float elapsed);
208 
219  void setRenderEffect(RenderEffect* effect);
220 
231  RenderEffect* getRenderEffect();
232 
243  void realiseGeometry();
244 
255  void invalidateGeometry();
256 
267  const RenderingSurface& getOwner() const;
268  RenderingSurface& getOwner();
269 
275  void unprojectPoint(const Vector2& p_in, Vector2& p_out);
276 
277  // overrides from base
278  void draw();
279  void invalidate();
280  bool isRenderingWindow() const;
281 
282 protected:
284  virtual void realiseGeometry_impl();
285 
287  void setOwner(RenderingSurface& owner);
288  // friend is so that RenderingSurface can call setOwner to xfer ownership.
290 
309 };
310 
311 } // End of CEGUI namespace section
312 
313 #endif // end of guard _CEGUIRenderingWindow_h_
TextureTarget & d_textarget
TextureTarget to draw to. Like d_target in base, but avoiding downcasts.
Definition: CEGUIRenderingWindow.h:294
Class used as a two dimensional vector (aka a Point)
Definition: CEGUIVector.h:45
Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.
Definition: CEGUIRenderEffect.h:41
Class used as a three dimensional vector.
Definition: CEGUIVector.h:130
Vector3 d_pivot
Pivot point used for the rotation.
Definition: CEGUIRenderingWindow.h:308
RenderingSurface * d_owner
RenderingSurface that owns this object, we render back to this object.
Definition: CEGUIRenderingWindow.h:296
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: CEGUIGeometryBuffer.h:42
Class that holds the size (width & height) of something.
Definition: CEGUISize.h:43
Vector3 d_rotation
Rotaions for this RenderingWindow.
Definition: CEGUIRenderingWindow.h:306
Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...
Definition: CEGUITextureTarget.h:41
virtual void transferRenderingWindow(RenderingWindow &window)
transfer ownership of the RenderingWindow to this RenderingSurface.
Renderer & d_renderer
holds ref to renderer
Definition: CEGUIRenderingWindow.h:292
RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...
Definition: CEGUIRenderingWindow.h:44
Abstract class defining the basic required interface for Renderer objects.
Definition: CEGUIRenderer.h:80
Vector2 d_position
Position of this RenderingWindow.
Definition: CEGUIRenderingWindow.h:302
Class that represents a surface that can have geometry based imagery drawn to it. ...
Definition: CEGUIRenderingSurface.h:109
GeometryBuffer * d_geometry
GeometryBuffer that holds geometry for drawing this window.
Definition: CEGUIRenderingWindow.h:298
Size d_size
Size of this RenderingWindow.
Definition: CEGUIRenderingWindow.h:304
bool d_geometryValid
indicates whether data in GeometryBuffer is up-to-date
Definition: CEGUIRenderingWindow.h:300
Class encapsulating operations on a Rectangle.
Definition: CEGUIRect.h:44