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 {
51  class _OgreExport RenderToVertexBuffer
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
Ogre::RenderToVertexBuffer::reset
virtual void reset()
Reset the vertex buffer to the initial state.
Definition: OgreRenderToVertexBuffer.h:111
Ogre::RenderToVertexBuffer::setSourceRenderable
void setSourceRenderable(Renderable *source)
Set the source renderable of this object.
Definition: OgreRenderToVertexBuffer.h:118
Ogre::RenderToVertexBuffer::getMaxVertexCount
unsigned int getMaxVertexCount() const
Get the maximum number of vertices that the buffer will hold.
Definition: OgreRenderToVertexBuffer.h:70
Ogre::RenderToVertexBuffer::setMaxVertexCount
void setMaxVertexCount(unsigned int maxVertexCount)
Set the maximum number of vertices that the buffer will hold.
Definition: OgreRenderToVertexBuffer.h:75
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::RenderToVertexBuffer::getSourceRenderable
const Renderable * getSourceRenderable() const
Get the source renderable of this object.
Definition: OgreRenderToVertexBuffer.h:123
Ogre::RenderToVertexBufferSharedPtr
SharedPtr< RenderToVertexBuffer > RenderToVertexBufferSharedPtr
Definition: OgreRenderToVertexBuffer.h:146
Ogre::RenderToVertexBuffer::mResetsEveryUpdate
bool mResetsEveryUpdate
Definition: OgreRenderToVertexBuffer.h:138
Ogre::RenderToVertexBuffer::mOperationType
RenderOperation::OperationType mOperationType
Definition: OgreRenderToVertexBuffer.h:137
Ogre::RenderToVertexBuffer::getResetsEveryUpdate
bool getResetsEveryUpdate() const
Does this object reset its buffer each time it updates?
Definition: OgreRenderToVertexBuffer.h:95
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
OgreMaterial.h
Ogre::VertexData
Summary class collecting together vertex source information.
Definition: OgreVertexIndexData.h:49
Ogre::RenderToVertexBuffer::mMaxVertexCount
unsigned int mMaxVertexCount
Definition: OgreRenderToVertexBuffer.h:143
OgreRenderOperation.h
Ogre::SceneManager
Manages the organisation and rendering of a 'scene' i.e.
Definition: OgreSceneManager.h:143
OgrePrerequisites.h
Ogre::VertexDeclaration
This class declares the format of a set of vertex inputs, which can be issued to the rendering API th...
Definition: OgreHardwareVertexBuffer.h:337
Ogre::RenderToVertexBuffer::mSourceRenderable
Renderable * mSourceRenderable
Definition: OgreRenderToVertexBuffer.h:141
Ogre::RenderToVertexBuffer::setOperationType
void setOperationType(RenderOperation::OperationType operationType)
Set the type of primitives that this object generates.
Definition: OgreRenderToVertexBuffer.h:85
Ogre::SharedPtr< Material >
Ogre::RenderToVertexBuffer::setResetsEveryUpdate
void setResetsEveryUpdate(bool resetsEveryUpdate)
Set whether this object resets its buffers each time it updates.
Definition: OgreRenderToVertexBuffer.h:90
Ogre::RenderToVertexBuffer::mMaterial
MaterialPtr mMaterial
Definition: OgreRenderToVertexBuffer.h:140
Ogre::RenderToVertexBuffer::mVertexData
VertexData * mVertexData
Definition: OgreRenderToVertexBuffer.h:142
Ogre::Renderable
Abstract class defining the interface all renderable objects must implement.
Definition: OgreRenderable.h:63
Ogre::RenderToVertexBuffer::mResetRequested
bool mResetRequested
Definition: OgreRenderToVertexBuffer.h:139
Ogre::RenderOperation::OperationType
OperationType
The rendering operation type to perform.
Definition: OgreRenderOperation.h:48
Ogre::RenderToVertexBuffer::getOperationType
RenderOperation::OperationType getOperationType() const
What type of primitives does this object generate?
Definition: OgreRenderToVertexBuffer.h:80
Ogre::RenderOperation
'New' rendering operation using vertex buffers.
Definition: OgreRenderOperation.h:45
Ogre::RenderToVertexBuffer
Definition: OgreRenderToVertexBuffer.h:51
Ogre::RenderToVertexBuffer::getRenderToBufferMaterial
const MaterialPtr & getRenderToBufferMaterial()
Get the material which is used to render the geometry into the vertex buffer.
Definition: OgreRenderToVertexBuffer.h:129

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 Tue Apr 13 2021 08:53:15