Crazy Eddie's GUI System  0.8.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
RendererModules/Ogre/GeometryBuffer.h
1 /***********************************************************************
2  created: Tue Feb 17 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 _CEGUIOgreGeometryBuffer_h_
28 #define _CEGUIOgreGeometryBuffer_h_
29 
30 #include "CEGUI/GeometryBuffer.h"
31 #include "CEGUI/RendererModules/Ogre/Renderer.h"
32 #include "CEGUI/Rect.h"
33 #include "CEGUI/Quaternion.h"
34 
35 #include <OgreMatrix4.h>
36 #include <OgreColourValue.h>
37 #include <OgreRenderOperation.h>
38 #include <OgreTexture.h>
39 
40 #include <utility>
41 #include <vector>
42 
43 // Ogre forward refs
44 namespace Ogre
45 {
46 class RenderSystem;
47 }
48 
49 // Start of CEGUI namespace section
50 namespace CEGUI
51 {
53 class OGRE_GUIRENDERER_API OgreGeometryBuffer : public GeometryBuffer
54 {
55 public:
57  OgreGeometryBuffer(OgreRenderer& owner, Ogre::RenderSystem& rs);
59  virtual ~OgreGeometryBuffer();
60 
62  const Ogre::Matrix4& getMatrix() const;
63 
64  // implement CEGUI::GeometryBuffer interface.
65  virtual void draw() const;
66  virtual void setTranslation(const Vector3f& v);
67  virtual void setRotation(const Quaternion& r);
68  virtual void setPivot(const Vector3f& p);
69  virtual void setClippingRegion(const Rectf& region);
70  virtual void appendVertex(const Vertex& vertex);
71  virtual void appendGeometry(const Vertex* const vbuff, uint vertex_count);
72  virtual void setActiveTexture(Texture* texture);
73  virtual void reset();
74  virtual Texture* getActiveTexture() const;
75  virtual uint getVertexCount() const;
76  virtual uint getBatchCount() const;
77  virtual void setRenderEffect(RenderEffect* effect);
78  virtual RenderEffect* getRenderEffect();
79  void setClippingActive(const bool active);
80  bool isClippingActive() const;
81 
82 protected:
84  Ogre::RGBA colourToOgre(const Colour& col) const;
86  void updateMatrix() const;
88  void syncHardwareBuffer() const;
90  void initialiseTextureStates() const;
91 
93  struct OgreVertex
94  {
95  float x, y, z;
96  Ogre::RGBA diffuse;
97  float u, v;
98  };
99 
101  struct BatchInfo
102  {
103  Ogre::TexturePtr texture;
104  uint vertexCount;
105  bool clip;
106  };
107 
111  Ogre::RenderSystem& d_renderSystem;
129  mutable Ogre::Matrix4 d_matrix;
131  mutable bool d_matrixValid;
133  mutable Ogre::RenderOperation d_renderOp;
135  mutable Ogre::HardwareVertexBufferSharedPtr d_hwBuffer;
137  mutable bool d_sync;
139  typedef std::vector<BatchInfo> BatchList;
143  typedef std::vector<OgreVertex> VertexList;
146 };
147 
148 
149 } // End of CEGUI namespace section
150 
151 #endif // end of guard _CEGUIOgreGeometryBuffer_h_
Rectf d_clipRect
rectangular clip region
Definition: RendererModules/Ogre/GeometryBuffer.h:115
Ogre::HardwareVertexBufferSharedPtr d_hwBuffer
H/W buffer where the vertices are rendered from.
Definition: RendererModules/Ogre/GeometryBuffer.h:135
CEGUI::Renderer implementation for the Ogre engine.
Definition: RendererModules/Ogre/Renderer.h:78
Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.
Definition: RenderEffect.h:40
Implementation of CEGUI::GeometryBuffer for the Ogre engine.
Definition: RendererModules/Ogre/GeometryBuffer.h:53
bool d_clippingActive
whether clipping will be active for the current batch
Definition: RendererModules/Ogre/GeometryBuffer.h:117
structure that is used to hold details of a single vertex in 3D space.
Definition: Vertex.h:40
std::vector< OgreVertex > VertexList
type of container used to queue the geometry
Definition: RendererModules/Ogre/GeometryBuffer.h:143
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:42
std::vector< BatchInfo > BatchList
type of container that tracks BatchInfos.
Definition: RendererModules/Ogre/GeometryBuffer.h:139
Ogre::Matrix4 d_matrix
model matrix cache
Definition: RendererModules/Ogre/GeometryBuffer.h:129
Quaternion d_rotation
rotation quaternion
Definition: RendererModules/Ogre/GeometryBuffer.h:121
VertexList d_vertices
container where added geometry is stored.
Definition: RendererModules/Ogre/GeometryBuffer.h:145
Ogre::RenderSystem & d_renderSystem
Ogre render system we're to use.
Definition: RendererModules/Ogre/GeometryBuffer.h:111
Vector3f d_translation
translation vector
Definition: RendererModules/Ogre/GeometryBuffer.h:119
Vector2f d_texelOffset
offset to be applied to all geometry
Definition: RendererModules/Ogre/GeometryBuffer.h:127
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:52
bool d_sync
whether the h/w buffer is in sync with the added geometry
Definition: RendererModules/Ogre/GeometryBuffer.h:137
type to track info for per-texture sub batches of geometry
Definition: RendererModules/Ogre/GeometryBuffer.h:101
OgreTexture * d_activeTexture
Texture that is set as active.
Definition: RendererModules/Ogre/GeometryBuffer.h:113
BatchList d_batches
list of texture batches added to the geometry buffer
Definition: RendererModules/Ogre/GeometryBuffer.h:141
Ogre::RenderOperation d_renderOp
Render operation for this buffer.
Definition: RendererModules/Ogre/GeometryBuffer.h:133
Implementation of the CEGUI::Texture class for the Ogre engine.
Definition: RendererModules/Ogre/Texture.h:38
vertex structure used internally and also by Ogre.
Definition: RendererModules/Ogre/GeometryBuffer.h:93
Class representing colour values within the system.
Definition: Colour.h:44
Class to represent rotation, avoids Gimbal lock.
Definition: Quaternion.h:67
RenderEffect * d_effect
RenderEffect that will be used by the GeometryBuffer.
Definition: RendererModules/Ogre/GeometryBuffer.h:125
bool d_matrixValid
true when d_matrix is valid and up to date
Definition: RendererModules/Ogre/GeometryBuffer.h:131
OgreRenderer & d_owner
Renderer object that owns this GeometryBuffer.
Definition: RendererModules/Ogre/GeometryBuffer.h:109
Vector3f d_pivot
pivot point for rotation
Definition: RendererModules/Ogre/GeometryBuffer.h:123