Crazy Eddie's GUI System  0.8.7
RendererModules/Direct3D9/GeometryBuffer.h
1 /***********************************************************************
2  created: Mon Feb 9 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 _CEGUIDirect3D9GeometryBuffer_h_
28 #define _CEGUIDirect3D9GeometryBuffer_h_
29 
30 #include "../../GeometryBuffer.h"
31 #include "CEGUI/RendererModules/Direct3D9/Renderer.h"
32 #include "../../Rect.h"
33 #include "../../Quaternion.h"
34 #include <d3dx9.h>
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 Direct3D9Texture;
47 
52 class DIRECT3D9_GUIRENDERER_API Direct3D9GeometryBuffer : public GeometryBuffer
53 {
54 public:
56  Direct3D9GeometryBuffer(Direct3D9Renderer& owner, LPDIRECT3DDEVICE9 device);
57 
59  const D3DXMATRIX* getMatrix() const;
60 
61  // implementation of abstract members from GeometryBuffer
62  void draw() const;
63  void setTranslation(const Vector3f& t);
64  void setRotation(const Quaternion& r);
65  void setPivot(const Vector3f& p);
66  void setClippingRegion(const Rectf& region);
67  void appendVertex(const Vertex& vertex);
68  void appendGeometry(const Vertex* const vbuff, uint vertex_count);
69  void setActiveTexture(Texture* texture);
70  void reset();
72  uint getVertexCount() const;
73  uint getBatchCount() const;
76  void setClippingActive(const bool active);
77  bool isClippingActive() const;
78 
79 protected:
83  void updateMatrix() const;
84 
86  struct D3DVertex
87  {
89  FLOAT x, y, z;
91  DWORD diffuse;
93  float tu, tv;
94  };
95 
97  struct BatchInfo
98  {
99  LPDIRECT3DTEXTURE9 texture;
100  uint vertexCount;
101  bool clip;
102  };
103 
109  typedef std::vector<BatchInfo> BatchList;
113  typedef std::vector<D3DVertex> VertexList;
129  LPDIRECT3DDEVICE9 d_device;
131  mutable D3DXMATRIX d_matrix;
133  mutable bool d_matrixValid;
134 };
135 
136 } // End of CEGUI namespace section
137 
138 #if defined(_MSC_VER)
139 # pragma warning(pop)
140 #endif
141 
142 #endif // end of guard _CEGUIDirect3D9GeometryBuffer_h_
CEGUI::GeometryBuffer
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
CEGUI::Direct3D9GeometryBuffer::d_clipRect
Rectf d_clipRect
rectangular clip region
Definition: RendererModules/Direct3D9/GeometryBuffer.h:117
CEGUI::Direct3D9GeometryBuffer
Direct3D9 based implementation of the GeometryBuffer interface.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:53
CEGUI::Direct3D9GeometryBuffer::d_pivot
Vector3f d_pivot
pivot point for rotation
Definition: RendererModules/Direct3D9/GeometryBuffer.h:125
CEGUI::Direct3D9GeometryBuffer::setClippingActive
void setClippingActive(const bool active)
Set whether clipping will be active for subsequently added vertices.
CEGUI::Direct3D9GeometryBuffer::BatchList
std::vector< BatchInfo > BatchList
type of container that tracks BatchInfos.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:109
CEGUI::Direct3D9GeometryBuffer::d_owner
Direct3D9Renderer & d_owner
Owning Direct3D9Renderer object.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:105
CEGUI::Direct3D9GeometryBuffer::d_translation
Vector3f d_translation
translation vector
Definition: RendererModules/Direct3D9/GeometryBuffer.h:121
CEGUI::Direct3D9GeometryBuffer::d_effect
RenderEffect * d_effect
RenderEffect that will be used by the GeometryBuffer.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:127
CEGUI::Direct3D9GeometryBuffer::d_matrix
D3DXMATRIX d_matrix
model matrix cache
Definition: RendererModules/Direct3D9/GeometryBuffer.h:131
CEGUI::Direct3D9GeometryBuffer::setRenderEffect
void setRenderEffect(RenderEffect *effect)
Set the RenderEffect to be used by this GeometryBuffer.
CEGUI::Direct3D9GeometryBuffer::draw
void draw() const
Draw the geometry buffered within this GeometryBuffer object.
CEGUI::Direct3D9GeometryBuffer::D3DVertex::x
FLOAT x
The transformed position for the vertex.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:89
CEGUI::Direct3D9GeometryBuffer::Direct3D9GeometryBuffer
Direct3D9GeometryBuffer(Direct3D9Renderer &owner, LPDIRECT3DDEVICE9 device)
Constructor.
CEGUI::Direct3D9GeometryBuffer::getActiveTexture
Texture * getActiveTexture() const
Return a pointer to the currently active Texture object. This may return 0 if no texture is set.
CEGUI::Direct3D9GeometryBuffer::d_activeTexture
Direct3D9Texture * d_activeTexture
last texture that was set as active
Definition: RendererModules/Direct3D9/GeometryBuffer.h:107
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::Direct3D9GeometryBuffer::D3DVertex::diffuse
DWORD diffuse
colour of the vertex.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:91
CEGUI::Direct3D9GeometryBuffer::setTranslation
void setTranslation(const Vector3f &t)
Set the translation to be applied to the geometry in the buffer when it is subsequently rendered.
CEGUI::Direct3D9GeometryBuffer::BatchInfo
type to track info for per-texture sub batches of geometry
Definition: RendererModules/Direct3D9/GeometryBuffer.h:98
CEGUI::Direct3D9GeometryBuffer::performBatchManagement
void performBatchManagement()
perform batch management operations prior to adding new geometry.
CEGUI::Vertex
structure that is used to hold details of a single vertex in 3D space.
Definition: Vertex.h:42
CEGUI::Direct3D9GeometryBuffer::d_batches
BatchList d_batches
list of texture batches added to the geometry buffer
Definition: RendererModules/Direct3D9/GeometryBuffer.h:111
CEGUI::Vector3< float >
CEGUI::Direct3D9GeometryBuffer::getBatchCount
uint getBatchCount() const
Return the number of batches of geometry that this GeometryBuffer has split the vertices into.
CEGUI::Direct3D9GeometryBuffer::updateMatrix
void updateMatrix() const
update cached matrix
CEGUI::Texture
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:54
CEGUI::Direct3D9GeometryBuffer::d_clippingActive
bool d_clippingActive
whether clipping will be active for the current batch
Definition: RendererModules/Direct3D9/GeometryBuffer.h:119
CEGUI::Direct3D9Texture
Texture implementation for the Direct3D9Renderer.
Definition: RendererModules/Direct3D9/Texture.h:45
CEGUI::Direct3D9GeometryBuffer::d_rotation
Quaternion d_rotation
rotation vector
Definition: RendererModules/Direct3D9/GeometryBuffer.h:123
CEGUI::Direct3D9GeometryBuffer::d_matrixValid
bool d_matrixValid
true when d_matrix is valid and up to date
Definition: RendererModules/Direct3D9/GeometryBuffer.h:133
CEGUI::Direct3D9GeometryBuffer::appendGeometry
void appendGeometry(const Vertex *const vbuff, uint vertex_count)
Append a number of vertices from an array to the GeometryBuffer.
CEGUI::Direct3D9GeometryBuffer::d_vertices
VertexList d_vertices
container where added geometry is stored.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:115
CEGUI::Direct3D9GeometryBuffer::setActiveTexture
void setActiveTexture(Texture *texture)
Set the active texture to be used with all subsequently added vertices.
CEGUI::Direct3D9GeometryBuffer::VertexList
std::vector< D3DVertex > VertexList
type of container used to queue the geometry
Definition: RendererModules/Direct3D9/GeometryBuffer.h:113
CEGUI::Direct3D9GeometryBuffer::appendVertex
void appendVertex(const Vertex &vertex)
Append a single vertex to the buffer.
CEGUI::Direct3D9GeometryBuffer::setClippingRegion
void setClippingRegion(const Rectf &region)
Set the clipping region to be used when rendering this buffer.
CEGUI::Direct3D9GeometryBuffer::getRenderEffect
RenderEffect * getRenderEffect()
Return the RenderEffect object that is assigned to this GeometryBuffer or 0 if none.
CEGUI::Direct3D9GeometryBuffer::getMatrix
const D3DXMATRIX * getMatrix() const
return pointer to D3DXMATRIX used as world transform.
CEGUI::Direct3D9GeometryBuffer::d_device
LPDIRECT3DDEVICE9 d_device
The D3D Device.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:129
CEGUI::Rect< float >
CEGUI::Direct3D9GeometryBuffer::reset
void reset()
Clear all buffered data and reset the GeometryBuffer to the default state.
CEGUI::Direct3D9GeometryBuffer::setPivot
void setPivot(const Vector3f &p)
Set the pivot point to be used when applying the rotations.
CEGUI::Direct3D9Renderer
Renderer class to interface with Direct3D 9.
Definition: RendererModules/Direct3D9/Renderer.h:65
CEGUI::Direct3D9GeometryBuffer::D3DVertex::tu
float tu
texture coordinates.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:93
CEGUI::Direct3D9GeometryBuffer::D3DVertex
internal Vertex structure used for Direct3D based geometry.
Definition: RendererModules/Direct3D9/GeometryBuffer.h:87
CEGUI::RenderEffect
Interface for objects that hook into RenderingWindow to affect the rendering process,...
Definition: RenderEffect.h:42
CEGUI::Direct3D9GeometryBuffer::getVertexCount
uint getVertexCount() const
Return the total number of vertices currently held by this GeometryBuffer object.
CEGUI::Direct3D9GeometryBuffer::setRotation
void setRotation(const Quaternion &r)
Set the rotations to be applied to the geometry in the buffer when it is subsequently rendered.