Crazy Eddie's GUI System  0.8.7
RendererModules/Null/GeometryBuffer.h
1 /***********************************************************************
2  created: Fri Jan 15 2010
3  author: Eugene Marcotte
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2010 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 _CEGUINullGeometryBuffer_h_
28 #define _CEGUINullGeometryBuffer_h_
29 
30 #include "../../GeometryBuffer.h"
31 #include "CEGUI/RendererModules/Null/Renderer.h"
32 #include "../../Rect.h"
33 #include "../../Colour.h"
34 #include "../../Vertex.h"
35 #include "../../Quaternion.h"
36 
37 #include <utility>
38 #include <vector>
39 
40 #if defined(_MSC_VER)
41 # pragma warning(push)
42 # pragma warning(disable : 4251)
43 #endif
44 
45 // Start of CEGUI namespace section
46 namespace CEGUI
47 {
49 class NULL_GUIRENDERER_API NullGeometryBuffer : public GeometryBuffer
50 {
51 public:
56 
57  // implement CEGUI::GeometryBuffer interface.
58  void draw() const;
59  void setTranslation(const Vector3f& v);
60  void setRotation(const Quaternion& r);
61  void setPivot(const Vector3f& p);
62  void setClippingRegion(const Rectf& region);
63  void appendVertex(const Vertex& vertex);
64  void appendGeometry(const Vertex* const vbuff, uint vertex_count);
65  void setActiveTexture(Texture* texture);
66  void reset();
68  uint getVertexCount() const;
69  uint getBatchCount() const;
72  void setClippingActive(const bool active);
73  bool isClippingActive() const;
74 
75 protected:
91  typedef std::vector<Vertex> VertexList;
94 };
95 
96 
97 } // End of CEGUI namespace section
98 
99 #if defined(_MSC_VER)
100 # pragma warning(pop)
101 #endif
102 
103 #endif // end of guard _CEGUINullGeometryBuffer_h_
CEGUI::GeometryBuffer
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
CEGUI::NullGeometryBuffer::d_activeTexture
NullTexture * d_activeTexture
Texture that is set as active.
Definition: RendererModules/Null/GeometryBuffer.h:77
CEGUI::NullTexture
Implementation of the CEGUI::Texture class for no particular engine.
Definition: RendererModules/Null/Texture.h:43
CEGUI::NullGeometryBuffer::draw
void draw() const
Draw the geometry buffered within this GeometryBuffer object.
CEGUI::NullGeometryBuffer::VertexList
std::vector< Vertex > VertexList
type of container used to queue the geometry
Definition: RendererModules/Null/GeometryBuffer.h:91
CEGUI::NullGeometryBuffer::setRotation
void setRotation(const Quaternion &r)
Set the rotations to be applied to the geometry in the buffer when it is subsequently rendered.
CEGUI::NullGeometryBuffer::d_pivot
Vector3f d_pivot
pivot point for rotation
Definition: RendererModules/Null/GeometryBuffer.h:87
CEGUI::NullGeometryBuffer::getBatchCount
uint getBatchCount() const
Return the number of batches of geometry that this GeometryBuffer has split the vertices into.
CEGUI::NullGeometryBuffer::getVertexCount
uint getVertexCount() const
Return the total number of vertices currently held by this GeometryBuffer object.
CEGUI::NullGeometryBuffer::d_effect
RenderEffect * d_effect
RenderEffect that will be used by the GeometryBuffer.
Definition: RendererModules/Null/GeometryBuffer.h:89
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::NullGeometryBuffer::d_translation
Vector3f d_translation
translation vector
Definition: RendererModules/Null/GeometryBuffer.h:83
CEGUI::NullGeometryBuffer::appendVertex
void appendVertex(const Vertex &vertex)
Append a single vertex to the buffer.
CEGUI::NullGeometryBuffer::d_vertices
VertexList d_vertices
container where added geometry is stored.
Definition: RendererModules/Null/GeometryBuffer.h:93
CEGUI::Vertex
structure that is used to hold details of a single vertex in 3D space.
Definition: Vertex.h:42
CEGUI::NullGeometryBuffer::setClippingActive
void setClippingActive(const bool active)
Set whether clipping will be active for subsequently added vertices.
CEGUI::NullGeometryBuffer::appendGeometry
void appendGeometry(const Vertex *const vbuff, uint vertex_count)
Append a number of vertices from an array to the GeometryBuffer.
CEGUI::Vector3< float >
CEGUI::NullGeometryBuffer::getRenderEffect
RenderEffect * getRenderEffect()
Return the RenderEffect object that is assigned to this GeometryBuffer or 0 if none.
CEGUI::NullGeometryBuffer
Implementation of CEGUI::GeometryBuffer for the Null engine.
Definition: RendererModules/Null/GeometryBuffer.h:50
CEGUI::Texture
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:54
CEGUI::NullGeometryBuffer::setClippingRegion
void setClippingRegion(const Rectf &region)
Set the clipping region to be used when rendering this buffer.
CEGUI::NullGeometryBuffer::d_clippingActive
bool d_clippingActive
whether clipping will be active for the current batch
Definition: RendererModules/Null/GeometryBuffer.h:81
CEGUI::NullGeometryBuffer::reset
void reset()
Clear all buffered data and reset the GeometryBuffer to the default state.
CEGUI::NullGeometryBuffer::d_clipRect
Rectf d_clipRect
rectangular clip region
Definition: RendererModules/Null/GeometryBuffer.h:79
CEGUI::NullGeometryBuffer::setPivot
void setPivot(const Vector3f &p)
Set the pivot point to be used when applying the rotations.
CEGUI::NullGeometryBuffer::~NullGeometryBuffer
virtual ~NullGeometryBuffer()
Destructor.
CEGUI::NullGeometryBuffer::getActiveTexture
Texture * getActiveTexture() const
Return a pointer to the currently active Texture object. This may return 0 if no texture is set.
CEGUI::NullGeometryBuffer::NullGeometryBuffer
NullGeometryBuffer()
Constructor.
CEGUI::NullGeometryBuffer::d_rotation
Quaternion d_rotation
rotation quaternion
Definition: RendererModules/Null/GeometryBuffer.h:85
CEGUI::NullGeometryBuffer::setTranslation
void setTranslation(const Vector3f &v)
Set the translation to be applied to the geometry in the buffer when it is subsequently rendered.
CEGUI::NullGeometryBuffer::setRenderEffect
void setRenderEffect(RenderEffect *effect)
Set the RenderEffect to be used by this GeometryBuffer.
CEGUI::Rect< float >
CEGUI::RenderEffect
Interface for objects that hook into RenderingWindow to affect the rendering process,...
Definition: RenderEffect.h:42
CEGUI::NullGeometryBuffer::setActiveTexture
void setActiveTexture(Texture *texture)
Set the active texture to be used with all subsequently added vertices.