OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreRenderToVertexBuffer.h
Go to the documentation of this file.
1 /*
2  -----------------------------------------------------------------------------
3  This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5  For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9  Permission is hereby granted, free of charge, to any person obtaining a copy
10  of this software and associated documentation files (the "Software"), to deal
11  in the Software without restriction, including without limitation the rights
12  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13  copies of the Software, and to permit persons to whom the Software is
14  furnished to do so, subject to the following conditions:
15 
16  The above copyright notice and this permission notice shall be included in
17  all copies or substantial portions of the Software.
18 
19  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25  THE SOFTWARE.
26  -----------------------------------------------------------------------------
27 */
28 #ifndef __RenderToVertexBuffer_H__
29 #define __RenderToVertexBuffer_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreRenderOperation.h"
33 
34 namespace Ogre {
51  {
52  public:
56  virtual ~RenderToVertexBuffer();
57 
64  VertexDeclaration* getVertexDeclaration();
65 
69  unsigned int getMaxVertexCount() const { return mMaxVertexCount; }
70 
74  void setMaxVertexCount(unsigned int maxVertexCount) { mMaxVertexCount = maxVertexCount; }
75 
79  RenderOperation::OperationType getOperationType() const { return mOperationType; }
80 
84  void setOperationType(RenderOperation::OperationType operationType) { mOperationType = operationType; }
85 
89  void setResetsEveryUpdate(bool resetsEveryUpdate) { mResetsEveryUpdate = resetsEveryUpdate; }
90 
94  bool getResetsEveryUpdate() const { return mResetsEveryUpdate; }
95 
99  virtual void getRenderOperation(RenderOperation& op) = 0;
100 
104  virtual void update(SceneManager* sceneMgr) = 0;
105 
110  virtual void reset() { mResetRequested = true; }
111 
117  void setSourceRenderable(Renderable* source) { mSourceRenderable = source; }
118 
122  const Renderable* getSourceRenderable() const { return mSourceRenderable; }
123 
128  const MaterialPtr& getRenderToBufferMaterial() { return mMaterial; }
129 
134  void setRenderToBufferMaterialName(const String& materialName);
135 
136  protected:
143  unsigned int mMaxVertexCount;
144  };
145 
148 }
149 
150 #endif
#define _OgreExport
Definition: OgrePlatform.h:255
virtual void reset()
Reset the vertex buffer to the initial state.
void setOperationType(RenderOperation::OperationType operationType)
Set the type of primitives that this object generates.
Manages the organisation and rendering of a 'scene' i.e.
RenderOperation::OperationType getOperationType() const
What type of primitives does this object generate?
An object which renders geometry to a vertex.
Abstract class defining the interface all renderable objects must implement.
const MaterialPtr & getRenderToBufferMaterial()
Get the material which is used to render the geometry into the vertex buffer.
unsigned int getMaxVertexCount() const
Get the maximum number of vertices that the buffer will hold.
Summary class collecting together vertex source information.
'New' rendering operation using vertex buffers.
This class declares the format of a set of vertex inputs, which can be issued to the rendering API th...
RenderOperation::OperationType mOperationType
void setResetsEveryUpdate(bool resetsEveryUpdate)
Set whether this object resets its buffers each time it updates.
bool getResetsEveryUpdate() const
Does this object reset its buffer each time it updates?
_StringBase String
Definition: OgreCommon.h:53
void setMaxVertexCount(unsigned int maxVertexCount)
Set the maximum number of vertices that the buffer will hold.
const Renderable * getSourceRenderable() const
Get the source renderable of this object.
void setSourceRenderable(Renderable *source)
Set the source renderable of this object.
OperationType
The rendering operation type to perform.