Crazy Eddie's GUI System  0.8.7
GeometryBufferBase.h
1 /***********************************************************************
2  created: Tue Apr 30 2013
3  authors: Paul D Turner <paul@cegui.org.uk>
4  Lukas E Meindl
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2013 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 _CEGUIGeometryBufferBase_h_
29 #define _CEGUIGeometryBufferBase_h_
30 
31 #include "../../GeometryBuffer.h"
32 #include "CEGUI/RendererModules/OpenGL/RendererBase.h"
33 #include "../../Rect.h"
34 #include "../../Quaternion.h"
35 
36 #include <utility>
37 #include <vector>
38 
39 #if defined(_MSC_VER)
40 # pragma warning(push)
41 # pragma warning(disable : 4251)
42 #endif
43 
44 namespace CEGUI
45 {
46 class OpenGLTexture;
47 
52 class OPENGL_GUIRENDERER_API OpenGLGeometryBufferBase : public GeometryBuffer
53 {
54 public:
57  virtual ~OpenGLGeometryBufferBase();
58 
59  // implementation of abstract members from GeometryBuffer
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 mat4Pimpl* 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 
95  struct BatchInfo
96  {
97  uint texture;
98  uint vertexCount;
99  bool clip;
100  };
101 
107  typedef std::vector<BatchInfo> BatchList;
111  typedef std::vector<GLVertex> VertexList;
127  mutable mat4Pimpl* d_matrix;
129  mutable bool d_matrixValid;
130 };
131 
132 }
133 
134 #if defined(_MSC_VER)
135 # pragma warning(pop)
136 #endif
137 
138 #endif
139 
CEGUI::GeometryBuffer
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
CEGUI::OpenGLGeometryBufferBase::getActiveTexture
Texture * getActiveTexture() const
Return a pointer to the currently active Texture object. This may return 0 if no texture is set.
CEGUI::OpenGLGeometryBufferBase::d_effect
RenderEffect * d_effect
RenderEffect that will be used by the GeometryBuffer.
Definition: GeometryBufferBase.h:125
CEGUI::OpenGLGeometryBufferBase::setTranslation
void setTranslation(const Vector3f &t)
Set the translation to be applied to the geometry in the buffer when it is subsequently rendered.
CEGUI::OpenGLGeometryBufferBase::performBatchManagement
void performBatchManagement()
perform batch management operations prior to adding new geometry.
CEGUI::OpenGLGeometryBufferBase::getVertexCount
uint getVertexCount() const
Return the total number of vertices currently held by this GeometryBuffer object.
CEGUI::OpenGLGeometryBufferBase::BatchInfo
type to track info for per-texture sub batches of geometry
Definition: GeometryBufferBase.h:96
CEGUI::OpenGLGeometryBufferBase::d_activeTexture
OpenGLTexture * d_activeTexture
last texture that was set as active
Definition: GeometryBufferBase.h:105
CEGUI::OpenGLGeometryBufferBase::setActiveTexture
void setActiveTexture(Texture *texture)
Set the active texture to be used with all subsequently added vertices.
CEGUI::OpenGLGeometryBufferBase::setClippingActive
void setClippingActive(const bool active)
Set whether clipping will be active for subsequently added vertices.
CEGUI::OpenGLGeometryBufferBase::setClippingRegion
void setClippingRegion(const Rectf &region)
Set the clipping region to be used when rendering this buffer.
CEGUI::OpenGLGeometryBufferBase::VertexList
std::vector< GLVertex > VertexList
type of container used to queue the geometry
Definition: GeometryBufferBase.h:111
CEGUI::OpenGLGeometryBufferBase::setRotation
void setRotation(const Quaternion &r)
Set the rotations to be applied to the geometry in the buffer when it is subsequently rendered.
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::OpenGLTexture
Texture implementation for the OpenGLRenderer.
Definition: RendererModules/OpenGL/Texture.h:45
CEGUI::OpenGLGeometryBufferBase::setRenderEffect
void setRenderEffect(RenderEffect *effect)
Set the RenderEffect to be used by this GeometryBuffer.
CEGUI::OpenGLGeometryBufferBase::d_clipRect
Rectf d_clipRect
rectangular clip region
Definition: GeometryBufferBase.h:115
CEGUI::Vertex
structure that is used to hold details of a single vertex in 3D space.
Definition: Vertex.h:42
CEGUI::OpenGLGeometryBufferBase::d_owner
OpenGLRendererBase * d_owner
OpenGLRendererBase that owns the GeometryBuffer.
Definition: GeometryBufferBase.h:103
CEGUI::Vector3< float >
CEGUI::OpenGLGeometryBufferBase::getRenderEffect
RenderEffect * getRenderEffect()
Return the RenderEffect object that is assigned to this GeometryBuffer or 0 if none.
CEGUI::OpenGLGeometryBufferBase::reset
void reset()
Clear all buffered data and reset the GeometryBuffer to the default state.
CEGUI::mat4Pimpl
Definition: GlmPimpl.h:37
CEGUI::OpenGLGeometryBufferBase::d_matrix
mat4Pimpl * d_matrix
model matrix cache - we use double because gluUnproject takes double
Definition: GeometryBufferBase.h:127
CEGUI::Texture
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:54
CEGUI::OpenGLGeometryBufferBase::d_batches
BatchList d_batches
list of texture batches added to the geometry buffer
Definition: GeometryBufferBase.h:109
CEGUI::OpenGLGeometryBufferBase
OpenGL based implementation of the GeometryBuffer interface.
Definition: GeometryBufferBase.h:53
CEGUI::OpenGLGeometryBufferBase::d_rotation
Quaternion d_rotation
rotation quaternion
Definition: GeometryBufferBase.h:121
CEGUI::OpenGLGeometryBufferBase::getBatchCount
uint getBatchCount() const
Return the number of batches of geometry that this GeometryBuffer has split the vertices into.
CEGUI::OpenGLGeometryBufferBase::appendGeometry
void appendGeometry(const Vertex *const vbuff, uint vertex_count)
Append a number of vertices from an array to the GeometryBuffer.
CEGUI::OpenGLGeometryBufferBase::GLVertex
internal Vertex structure used for GL based geometry.
Definition: GeometryBufferBase.h:88
CEGUI::OpenGLGeometryBufferBase::d_clippingActive
bool d_clippingActive
whether clipping will be active for the current batch
Definition: GeometryBufferBase.h:117
CEGUI::OpenGLGeometryBufferBase::appendVertex
void appendVertex(const Vertex &vertex)
Append a single vertex to the buffer.
CEGUI::OpenGLGeometryBufferBase::updateMatrix
void updateMatrix() const
update cached matrix
CEGUI::OpenGLGeometryBufferBase::BatchList
std::vector< BatchInfo > BatchList
type of container that tracks BatchInfos.
Definition: GeometryBufferBase.h:107
CEGUI::OpenGLGeometryBufferBase::d_matrixValid
bool d_matrixValid
true when d_matrix is valid and up to date
Definition: GeometryBufferBase.h:129
CEGUI::OpenGLGeometryBufferBase::OpenGLGeometryBufferBase
OpenGLGeometryBufferBase(OpenGLRendererBase &owner)
Constructor.
CEGUI::Rect< float >
CEGUI::OpenGLGeometryBufferBase::setPivot
void setPivot(const Vector3f &p)
Set the pivot point to be used when applying the rotations.
CEGUI::RenderEffect
Interface for objects that hook into RenderingWindow to affect the rendering process,...
Definition: RenderEffect.h:42
CEGUI::OpenGLRendererBase
Common base class used for other OpenGL (desktop or ES) based renderer modules.
Definition: RendererBase.h:54
CEGUI::OpenGLGeometryBufferBase::getMatrix
const mat4Pimpl * getMatrix() const
return the GL modelview matrix used for this buffer.
CEGUI::OpenGLGeometryBufferBase::d_translation
Vector3f d_translation
translation vector
Definition: GeometryBufferBase.h:119
CEGUI::OpenGLGeometryBufferBase::d_pivot
Vector3f d_pivot
pivot point for rotation
Definition: GeometryBufferBase.h:123
CEGUI::OpenGLGeometryBufferBase::d_vertices
VertexList d_vertices
container where added geometry is stored.
Definition: GeometryBufferBase.h:113