Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUIOgreGeometryBuffer.h
1 /***********************************************************************
2  filename: CEGUIOgreGeometryBuffer.h
3  created: Tue Feb 17 2009
4  author: Paul D Turner
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2010 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 _CEGUIOgreGeometryBuffer_h_
29 #define _CEGUIOgreGeometryBuffer_h_
30 
31 #include "../../CEGUIGeometryBuffer.h"
32 #include "CEGUIOgreRenderer.h"
33 #include "../../CEGUIRect.h"
34 
35 #include <OgreMatrix4.h>
36 #include <OgreColourValue.h>
37 #include <OgreRenderOperation.h>
38 
39 #include <utility>
40 #include <vector>
41 
42 // Ogre forward refs
43 namespace Ogre
44 {
45 class RenderSystem;
46 }
47 
48 // Start of CEGUI namespace section
49 namespace CEGUI
50 {
52 class OGRE_GUIRENDERER_API OgreGeometryBuffer : public GeometryBuffer
53 {
54 public:
56  OgreGeometryBuffer(OgreRenderer& owner, Ogre::RenderSystem& rs);
58  virtual ~OgreGeometryBuffer();
59 
61  const Ogre::Matrix4& getMatrix() const;
62 
63  // implement CEGUI::GeometryBuffer interface.
64  void draw() const;
65  void setTranslation(const Vector3& v);
66  void setRotation(const Vector3& r);
67  void setPivot(const Vector3& p);
68  void setClippingRegion(const Rect& region);
69  void appendVertex(const Vertex& vertex);
70  void appendGeometry(const Vertex* const vbuff, uint vertex_count);
71  void setActiveTexture(Texture* texture);
72  void reset();
73  Texture* getActiveTexture() const;
74  uint getVertexCount() const;
75  uint getBatchCount() const;
76  void setRenderEffect(RenderEffect* effect);
77  RenderEffect* getRenderEffect();
78 
79 protected:
81  Ogre::RGBA colourToOgre(const colour& col) const;
83  void updateMatrix() const;
85  void syncHardwareBuffer() const;
87  void initialiseTextureStates() const;
88 
90  struct OgreVertex
91  {
92  float x, y, z;
93  Ogre::RGBA diffuse;
94  float u, v;
95  };
96 
100  Ogre::RenderSystem& d_renderSystem;
116  mutable Ogre::Matrix4 d_matrix;
118  mutable bool d_matrixValid;
120  mutable Ogre::RenderOperation d_renderOp;
122  mutable Ogre::HardwareVertexBufferSharedPtr d_hwBuffer;
124  mutable bool d_sync;
126  typedef std::pair<Ogre::TexturePtr, uint> BatchInfo;
128  typedef std::vector<BatchInfo> BatchList;
132  typedef std::vector<OgreVertex> VertexList;
135 };
136 
137 
138 } // End of CEGUI namespace section
139 
140 #endif // end of guard _CEGUIOgreGeometryBuffer_h_
Class used as a two dimensional vector (aka a Point)
Definition: CEGUIVector.h:45
Ogre::HardwareVertexBufferSharedPtr d_hwBuffer
H/W buffer where the vertices are rendered from.
Definition: CEGUIOgreGeometryBuffer.h:122
CEGUI::Renderer implementation for the Ogre engine.
Definition: CEGUIOgreRenderer.h:72
Vector3 d_translation
translation vector
Definition: CEGUIOgreGeometryBuffer.h:106
Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.
Definition: CEGUIRenderEffect.h:41
Implementation of CEGUI::GeometryBuffer for the Ogre engine.
Definition: CEGUIOgreGeometryBuffer.h:52
Class used as a three dimensional vector.
Definition: CEGUIVector.h:130
structure that is used to hold details of a single vertex in 3D space.
Definition: CEGUIVertex.h:41
std::vector< OgreVertex > VertexList
type of container used to queue the geometry
Definition: CEGUIOgreGeometryBuffer.h:132
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: CEGUIGeometryBuffer.h:42
std::vector< BatchInfo > BatchList
type of container that tracks BatchInfos.
Definition: CEGUIOgreGeometryBuffer.h:128
Ogre::Matrix4 d_matrix
model matrix cache
Definition: CEGUIOgreGeometryBuffer.h:116
Class representing colour values within the system.
Definition: CEGUIcolour.h:45
std::pair< Ogre::TexturePtr, uint > BatchInfo
type to track info for per-texture sub batches of geometry
Definition: CEGUIOgreGeometryBuffer.h:126
VertexList d_vertices
container where added geometry is stored.
Definition: CEGUIOgreGeometryBuffer.h:134
Ogre::RenderSystem & d_renderSystem
Ogre render system we&#39;re to use.
Definition: CEGUIOgreGeometryBuffer.h:100
Rect d_clipRect
rectangular clip region
Definition: CEGUIOgreGeometryBuffer.h:104
Abstract base class specifying the required interface for Texture objects.
Definition: CEGUITexture.h:50
bool d_sync
whether the h/w buffer is in sync with the added geometry
Definition: CEGUIOgreGeometryBuffer.h:124
Vector3 d_pivot
pivot point for rotation
Definition: CEGUIOgreGeometryBuffer.h:110
OgreTexture * d_activeTexture
Texture that is set as active.
Definition: CEGUIOgreGeometryBuffer.h:102
BatchList d_batches
list of texture batches added to the geometry buffer
Definition: CEGUIOgreGeometryBuffer.h:130
Ogre::RenderOperation d_renderOp
Render operation for this buffer.
Definition: CEGUIOgreGeometryBuffer.h:120
Implementation of the CEGUI::Texture class for the Ogre engine.
Definition: CEGUIOgreTexture.h:39
vertex structure used internally and also by Ogre.
Definition: CEGUIOgreGeometryBuffer.h:90
Vector2 d_texelOffset
offset to be applied to all geometry
Definition: CEGUIOgreGeometryBuffer.h:114
Vector3 d_rotation
rotation vector
Definition: CEGUIOgreGeometryBuffer.h:108
RenderEffect * d_effect
RenderEffect that will be used by the GeometryBuffer.
Definition: CEGUIOgreGeometryBuffer.h:112
bool d_matrixValid
true when d_matrix is valid and up to date
Definition: CEGUIOgreGeometryBuffer.h:118
OgreRenderer & d_owner
Renderer object that owns this GeometryBuffer.
Definition: CEGUIOgreGeometryBuffer.h:98
Class encapsulating operations on a Rectangle.
Definition: CEGUIRect.h:44