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-2013 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 "OgreMaterial.h"
33 #include "OgreRenderOperation.h"
34 
35 namespace Ogre {
52  {
53  public:
57  virtual ~RenderToVertexBuffer();
58 
65  VertexDeclaration* getVertexDeclaration();
66 
70  unsigned int getMaxVertexCount() const { return mMaxVertexCount; }
71 
75  void setMaxVertexCount(unsigned int maxVertexCount) { mMaxVertexCount = maxVertexCount; }
76 
80  RenderOperation::OperationType getOperationType() const { return mOperationType; }
81 
85  void setOperationType(RenderOperation::OperationType operationType) { mOperationType = operationType; }
86 
90  void setResetsEveryUpdate(bool resetsEveryUpdate) { mResetsEveryUpdate = resetsEveryUpdate; }
91 
95  bool getResetsEveryUpdate() const { return mResetsEveryUpdate; }
96 
100  virtual void getRenderOperation(RenderOperation& op) = 0;
101 
105  virtual void update(SceneManager* sceneMgr) = 0;
106 
111  virtual void reset() { mResetRequested = true; }
112 
118  void setSourceRenderable(Renderable* source) { mSourceRenderable = source; }
119 
123  const Renderable* getSourceRenderable() const { return mSourceRenderable; }
124 
129  const MaterialPtr& getRenderToBufferMaterial() { return mMaterial; }
130 
135  void setRenderToBufferMaterialName(const String& materialName);
136  protected:
143  unsigned int mMaxVertexCount;
144  };
145 
149 }
150 
151 #endif
Abstract class defining the interface all renderable objects must implement.
#define _OgreExport
Definition: OgrePlatform.h:257
Summary class collecting together vertex source information.
OperationType
The rendering operation type to perform.
unsigned int getMaxVertexCount() const
Get the maximum number of vertices that the buffer will hold.
bool getResetsEveryUpdate() const
Does this object reset its buffer each time it updates?
const MaterialPtr & getRenderToBufferMaterial()
Get the material which is used to render the geometry into the vertex buffer.
An object which renders geometry to a vertex.
This class declares the format of a set of vertex inputs, which can be issued to the rendering API th...
void setResetsEveryUpdate(bool resetsEveryUpdate)
Set whether this object resets its buffers each time it updates.
SharedPtr< RenderToVertexBuffer > RenderToVertexBufferSharedPtr
_StringBase String
virtual void reset()
Reset the vertex buffer to the initial state.
const Renderable * getSourceRenderable() const
Get the source renderable of this object.
void setOperationType(RenderOperation::OperationType operationType)
Set the type of primitives that this object generates.
void setMaxVertexCount(unsigned int maxVertexCount)
Set the maximum number of vertices that the buffer will hold.
RenderOperation::OperationType getOperationType() const
What type of primitives does this object generate?
'New' rendering operation using vertex buffers.
void setSourceRenderable(Renderable *source)
Set the source renderable of this object.
Manages the organisation and rendering of a 'scene' i.e.
RenderOperation::OperationType mOperationType

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sat Oct 25 2014 14:52:01