Crazy Eddie's GUI System  0.8.7
RendererModules/OpenGLES/GeometryBuffer.h
1 /***********************************************************************
2  created: Thu Jan 8 2009
3  author: Paul D Turner
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2009 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 _CEGUIOpenGLESGeometryBuffer_h_
28 #define _CEGUIOpenGLESGeometryBuffer_h_
29 
30 #include "CEGUI/GeometryBuffer.h"
31 #include "CEGUI/RendererModules/OpenGLES/Renderer.h"
32 #include "CEGUI/Rect.h"
33 #include "CEGUI/Quaternion.h"
34 
35 #include <utility>
36 #include <vector>
37 
38 #if defined(_MSC_VER)
39 # pragma warning(push)
40 # pragma warning(disable : 4251)
41 #endif
42 
43 // Start of CEGUI namespace section
44 namespace CEGUI
45 {
46 class OpenGLESTexture;
47 
52 class OPENGLES_GUIRENDERER_API OpenGLESGeometryBuffer : public GeometryBuffer
53 {
54 public:
57 
58  // implementation of abstract members from GeometryBuffer
59  void draw() const;
60  void setTranslation(const Vector3f& t);
61  void setRotation(const Quaternion& r);
62  void setPivot(const Vector3f& p);
63  void setClippingRegion(const Rectf& region);
64  void appendVertex(const Vertex& vertex);
65  void appendGeometry(const Vertex* const vbuff, uint vertex_count);
66  void setActiveTexture(Texture* texture);
67  void reset();
69  uint getVertexCount() const;
70  uint getBatchCount() const;
73  void setClippingActive(const bool active);
74  bool isClippingActive() const;
75 
77  const float* getMatrix() const;
78 
79 protected:
82 
84  void updateMatrix() const;
85 
87  struct GLVertex
88  {
89  float tex[2];
90  float colour[4];
91  float position[3];
92  };
93 
97  typedef std::pair<uint, uint> BatchInfo;
99  typedef std::vector<BatchInfo> BatchList;
103  typedef std::vector<GLVertex> VertexList;
119  mutable float d_matrix[16];
121  mutable bool d_matrixValid;
122 };
123 
124 
125 } // End of CEGUI namespace section
126 
127 #if defined(_MSC_VER)
128 # pragma warning(pop)
129 #endif
130 
131 #endif // end of guard _CEGUIOpenGLESGeometryBuffer_h_
CEGUI::GeometryBuffer
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
CEGUI::OpenGLESGeometryBuffer::BatchList
std::vector< BatchInfo > BatchList
type of container that tracks BatchInfos.
Definition: RendererModules/OpenGLES/GeometryBuffer.h:99
CEGUI::OpenGLESGeometryBuffer::d_effect
RenderEffect * d_effect
RenderEffect that will be used by the GeometryBuffer.
Definition: RendererModules/OpenGLES/GeometryBuffer.h:117
CEGUI::OpenGLESGeometryBuffer::getActiveTexture
Texture * getActiveTexture() const
Return a pointer to the currently active Texture object. This may return 0 if no texture is set.
CEGUI::OpenGLESGeometryBuffer::d_pivot
Vector3f d_pivot
pivot point for rotation
Definition: RendererModules/OpenGLES/GeometryBuffer.h:115
CEGUI::OpenGLESGeometryBuffer::reset
void reset()
Clear all buffered data and reset the GeometryBuffer to the default state.
CEGUI::OpenGLESGeometryBuffer::setTranslation
void setTranslation(const Vector3f &t)
Set the translation to be applied to the geometry in the buffer when it is subsequently rendered.
CEGUI::OpenGLESGeometryBuffer::appendGeometry
void appendGeometry(const Vertex *const vbuff, uint vertex_count)
Append a number of vertices from an array to the GeometryBuffer.
CEGUI::OpenGLESGeometryBuffer::setRotation
void setRotation(const Quaternion &r)
Set the rotations to be applied to the geometry in the buffer when it is subsequently rendered.
CEGUI::OpenGLESGeometryBuffer::performBatchManagement
void performBatchManagement()
perform batch management operations prior to adding new geometry.
CEGUI::OpenGLESGeometryBuffer::d_translation
Vector3f d_translation
translation vector
Definition: RendererModules/OpenGLES/GeometryBuffer.h:111
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::Quaternion
Class to represent rotation, avoids Gimbal lock.
Definition: Quaternion.h:69
CEGUI::OpenGLESGeometryBuffer::VertexList
std::vector< GLVertex > VertexList
type of container used to queue the geometry
Definition: RendererModules/OpenGLES/GeometryBuffer.h:103
CEGUI::OpenGLESGeometryBuffer::d_clipRect
Rectf d_clipRect
rectangular clip region
Definition: RendererModules/OpenGLES/GeometryBuffer.h:107
CEGUI::OpenGLESGeometryBuffer::getRenderEffect
RenderEffect * getRenderEffect()
Return the RenderEffect object that is assigned to this GeometryBuffer or 0 if none.
CEGUI::OpenGLESGeometryBuffer::setClippingRegion
void setClippingRegion(const Rectf &region)
Set the clipping region to be used when rendering this buffer.
CEGUI::OpenGLESGeometryBuffer::updateMatrix
void updateMatrix() const
update cached matrix
CEGUI::OpenGLESGeometryBuffer::d_activeTexture
OpenGLESTexture * d_activeTexture
last texture that was set as active
Definition: RendererModules/OpenGLES/GeometryBuffer.h:95
CEGUI::OpenGLESGeometryBuffer::getMatrix
const float * getMatrix() const
return the GL modelview matrix used for this buffer.
CEGUI::OpenGLESGeometryBuffer::d_rotation
Quaternion d_rotation
rotation quaternion
Definition: RendererModules/OpenGLES/GeometryBuffer.h:113
CEGUI::OpenGLESGeometryBuffer::d_clippingActive
bool d_clippingActive
whether clipping will be active for the current batch
Definition: RendererModules/OpenGLES/GeometryBuffer.h:109
CEGUI::OpenGLESGeometryBuffer::d_vertices
VertexList d_vertices
container where added geometry is stored.
Definition: RendererModules/OpenGLES/GeometryBuffer.h:105
CEGUI::OpenGLESGeometryBuffer::setPivot
void setPivot(const Vector3f &p)
Set the pivot point to be used when applying the rotations.
CEGUI::Vertex
structure that is used to hold details of a single vertex in 3D space.
Definition: Vertex.h:42
CEGUI::Vector3< float >
CEGUI::OpenGLESGeometryBuffer::getVertexCount
uint getVertexCount() const
Return the total number of vertices currently held by this GeometryBuffer object.
CEGUI::OpenGLESGeometryBuffer::GLVertex
internal Vertex structure used for GL based geometry.
Definition: RendererModules/OpenGLES/GeometryBuffer.h:88
CEGUI::OpenGLESGeometryBuffer::setClippingActive
void setClippingActive(const bool active)
Set whether clipping will be active for subsequently added vertices.
CEGUI::Texture
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:54
CEGUI::OpenGLESGeometryBuffer
OpenGLES based implementation of the GeometryBuffer interface.
Definition: RendererModules/OpenGLES/GeometryBuffer.h:53
CEGUI::OpenGLESGeometryBuffer::d_batches
BatchList d_batches
list of texture batches added to the geometry buffer
Definition: RendererModules/OpenGLES/GeometryBuffer.h:101
CEGUI::OpenGLESGeometryBuffer::d_matrixValid
bool d_matrixValid
true when d_matrix is valid and up to date
Definition: RendererModules/OpenGLES/GeometryBuffer.h:121
CEGUI::OpenGLESGeometryBuffer::draw
void draw() const
Draw the geometry buffered within this GeometryBuffer object.
CEGUI::OpenGLESGeometryBuffer::setRenderEffect
void setRenderEffect(RenderEffect *effect)
Set the RenderEffect to be used by this GeometryBuffer.
CEGUI::OpenGLESGeometryBuffer::setActiveTexture
void setActiveTexture(Texture *texture)
Set the active texture to be used with all subsequently added vertices.
CEGUI::OpenGLESGeometryBuffer::getBatchCount
uint getBatchCount() const
Return the number of batches of geometry that this GeometryBuffer has split the vertices into.
CEGUI::OpenGLESGeometryBuffer::appendVertex
void appendVertex(const Vertex &vertex)
Append a single vertex to the buffer.
CEGUI::Rect< float >
CEGUI::OpenGLESGeometryBuffer::OpenGLESGeometryBuffer
OpenGLESGeometryBuffer()
Constructor.
CEGUI::RenderEffect
Interface for objects that hook into RenderingWindow to affect the rendering process,...
Definition: RenderEffect.h:42
CEGUI::OpenGLESTexture
Texture implementation for the OpenGLESRenderer.
Definition: RendererModules/OpenGLES/Texture.h:40
CEGUI::OpenGLESGeometryBuffer::BatchInfo
std::pair< uint, uint > BatchInfo
type to track info for per-texture sub batches of geometry
Definition: RendererModules/OpenGLES/GeometryBuffer.h:97