Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::VertexData Class Reference

Summary class collecting together vertex source information. More...

#include <OgreVertexIndexData.h>

List of all members.

Public Methods

 VertexData ()
 ~VertexData ()
VertexData * clone (bool copyData=true) const
 Clones this vertex data, potentially including replicating any vertex buffers.

void prepareForShadowVolume (void)
 Modifies the vertex data to be suitable for use for rendering shadow geometry.


Public Attributes

VertexDeclarationvertexDeclaration
 Declaration of the vertex to be used in this operation.

VertexBufferBindingvertexBufferBinding
 The vertex buffer bindings to be used.

size_t vertexStart
 The base vertex index to start from, if using unindexed geometry.

size_t vertexCount
 The number of vertices used in this operation.

HardwareVertexBufferSharedPtr hardwareShadowVolWBuffer
 Additional shadow volume vertex buffer storage.


Private Methods

 VertexData (const VertexData &rhs)
 Protected copy constructor, to prevent misuse.

VertexData & operator= (const VertexData &rhs)
 Protected operator=, to prevent misuse.


Detailed Description

Summary class collecting together vertex source information.

Definition at line 35 of file OgreVertexIndexData.h.


Constructor & Destructor Documentation

Ogre::VertexData::VertexData const VertexData &    rhs [private]
 

Protected copy constructor, to prevent misuse.

Definition at line 39 of file OgreVertexIndexData.h.

Ogre::VertexData::VertexData  
 

Definition at line 38 of file OgreVertexIndexData.cpp.

References vertexBufferBinding, vertexCount, vertexDeclaration, and vertexStart.

Referenced by clone().

Ogre::VertexData::~VertexData  
 

Definition at line 49 of file OgreVertexIndexData.cpp.

References vertexBufferBinding, and vertexDeclaration.


Member Function Documentation

VertexData * Ogre::VertexData::clone bool    copyData = true const
 

Clones this vertex data, potentially including replicating any vertex buffers.

Remarks:
The caller is expected to delete the returned pointer when ready

Definition at line 57 of file OgreVertexIndexData.cpp.

References Ogre::VertexDeclaration::addElement(), Ogre::VertexBufferBinding::getBindings(), Ogre::VertexDeclaration::getElements(), Ogre::VertexBufferBinding::setBinding(), vertexBufferBinding, vertexCount, VertexData(), vertexDeclaration, and vertexStart.

Referenced by Ogre::Mesh::clone(), and Ogre::Entity::cloneVertexDataRemoveBlendInfo().

VertexData& Ogre::VertexData::operator= const VertexData &    rhs [private]
 

Protected operator=, to prevent misuse.

Definition at line 41 of file OgreVertexIndexData.h.

void Ogre::VertexData::prepareForShadowVolume void   
 

Modifies the vertex data to be suitable for use for rendering shadow geometry.

Remarks:
Preparing vertex data to generate a shadow volume involves firstly ensuring that the vertex buffer containing the positions is a standalone vertex buffer, with no other components in it. This method will therefore break apart any existing vertex buffers if position is sharing a vertex buffer. Secondly, it will double the size of this vertex buffer so that there are 2 copies of the position data for the mesh. The first half is used for the original, and the second half is used for the 'extruded' version. The vertex count used to render will remain the same though, so as not to add any overhead to regular rendering of the object. Both copies of the position are required in one buffer because shadow volumes stretch from the original mesh to the extruded version.

It's important to appreciate that this method can fundamentally change the structure of your vertex buffers, although in reality they will be new buffers. As it happens, if other objects are using the original buffers then they will be unaffected because the reference counting will keep them intact. However, if you have made any assumptions about the structure of the vertex data in the buffers of this object, you may have to rethink them.

Definition at line 113 of file OgreVertexIndexData.cpp.

References Ogre::VertexElement::baseVertexPointerToElement(), Ogre::VertexDeclaration::findElementBySemantic(), Ogre::VertexBufferBinding::getBuffer(), Ogre::RenderSystem::getCapabilities(), Ogre::VertexDeclaration::getElements(), Ogre::VertexBufferBinding::getNextIndex(), Ogre::VertexElement::getOffset(), Ogre::VertexElement::getSize(), Ogre::VertexElement::getSource(), hardwareShadowVolWBuffer, Ogre::RenderSystemCapabilities::hasCapability(), Ogre::VertexDeclaration::modifyElement(), Ogre::Real, Ogre::RSC_VERTEX_PROGRAM, Ogre::VertexBufferBinding::setBinding(), vertexBufferBinding, vertexDeclaration, Ogre::VES_POSITION, and Ogre::VET_FLOAT3.

Referenced by Ogre::Mesh::prepareForShadowVolume().


Member Data Documentation

HardwareVertexBufferSharedPtr Ogre::VertexData::hardwareShadowVolWBuffer
 

Additional shadow volume vertex buffer storage.

Remarks:
This additional buffer is only used where we have prepared this VertexData for use in shadow volume contruction, and where the current render system supports vertex programs. This buffer contains the 'w' vertex position component which will be used by that program to differentiate between extruded and non-extruded vertices. This 'w' component cannot be included in the original position buffer because DirectX does not allow 4-component positions in the fixed-function pipeline, and the original position buffer must still be usable for fixed-function rendering.

Note that we don't store any vertex declaration or vertex buffer binding here becuase this can be reused in the shadow algorithm.

Definition at line 98 of file OgreVertexIndexData.h.

Referenced by Ogre::Entity::cloneVertexDataRemoveBlendInfo(), Ogre::Entity::EntityShadowRenderable::EntityShadowRenderable(), and prepareForShadowVolume().

VertexBufferBinding* Ogre::VertexData::vertexBufferBinding
 

The vertex buffer bindings to be used.

Remarks:
Note that this is created for you on construction.

Definition at line 53 of file OgreVertexIndexData.h.

Referenced by Ogre::TerrainRenderable::_calculateNormals(), Ogre::TerrainRenderable::_generateVertexLighting(), Ogre::BillboardSet::_notifyCurrentCamera(), Ogre::GLRenderSystem::_render(), Ogre::D3D9RenderSystem::_render(), Ogre::D3DRenderSystem::_render(), Ogre::TerrainRenderable::_vertex(), Ogre::ProgressiveMesh::addWorkingData(), Ogre::TempBlendedBufferInfo::bindTempCopies(), Ogre::BspLevel::buildQuake3Patches(), Ogre::Mesh::buildTangentVectors(), Ogre::EdgeListBuilder::buildTrianglesEdges(), Ogre::TTYGuiElement::checkMemoryAllocation(), Ogre::TextAreaGuiElement::checkMemoryAllocation(), clone(), Ogre::Entity::cloneVertexDataRemoveBlendInfo(), Ogre::Mesh::compileBoneAssignments(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::MeshManager::createPrefabPlane(), Ogre::Entity::EntityShadowRenderable::EntityShadowRenderable(), Ogre::Entity::extractTempBufferInfo(), Ogre::Frustum::Frustum(), Ogre::BorderPanelGuiElement::getCellUVString(), Ogre::Mesh::getTangentsBuffer(), Ogre::TerrainRenderable::init(), Ogre::PanelGuiElement::initialise(), Ogre::BorderPanelGuiElement::initialise(), Ogre::PatchMesh::load(), Ogre::BspLevel::loadQuake3Level(), Ogre::EdgeListBuilder::log(), prepareForShadowVolume(), Ogre::MeshSerializerImpl_v1::readGeometry(), Ogre::MeshSerializerImpl::readGeometryColours(), Ogre::MeshSerializerImpl::readGeometryNormals(), Ogre::MeshSerializerImpl::readGeometryPositions(), Ogre::MeshSerializerImpl_v1_1::readGeometryTexCoords(), Ogre::MeshSerializerImpl::readGeometryTexCoords(), Ogre::Entity::EntityShadowRenderable::rebindPositionBuffer(), Ogre::Rectangle2D::Rectangle2D(), Ogre::BorderPanelGuiElement::setCellUV(), Ogre::Rectangle2D::setCorners(), Ogre::BillboardSet::setPoolSize(), Ogre::WireBoundingBox::setupBoundingBoxVertices(), Ogre::Mesh::softwareVertexBlend(), Ogre::TextAreaGuiElement::updateColours(), Ogre::Frustum::updateFrustum(), Ogre::TextAreaGuiElement::updateGeometry(), Ogre::PanelGuiElement::updatePositionGeometry(), Ogre::BorderPanelGuiElement::updatePositionGeometry(), Ogre::PanelGuiElement::updateTextureGeometry(), Ogre::TTYGuiElement::updateWindowGeometry(), VertexData(), Ogre::WireBoundingBox::WireBoundingBox(), Ogre::MeshSerializerImpl::writeGeometry(), and ~VertexData().

size_t Ogre::VertexData::vertexCount
 

The number of vertices used in this operation.

Definition at line 57 of file OgreVertexIndexData.h.

Referenced by Ogre::SubMesh::_compileBoneAssignments(), Ogre::Mesh::_compileBoneAssignments(), Ogre::RenderSystem::_render(), Ogre::GLRenderSystem::_render(), Ogre::D3D9RenderSystem::_render(), Ogre::D3DRenderSystem::_render(), Ogre::ProgressiveMesh::addWorkingData(), Ogre::Mesh::buildTangentVectors(), Ogre::MeshSerializerImpl::calcGeometrySize(), Ogre::MeshSerializerImpl::calcMeshSize(), Ogre::TTYGuiElement::checkAndSetUpdateGeometry(), Ogre::TTYGuiElement::checkMemoryAllocation(), Ogre::TextAreaGuiElement::checkMemoryAllocation(), clone(), Ogre::Mesh::compileBoneAssignments(), Ogre::ProgressiveMesh::computeAllCosts(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::MeshManager::createPrefabPlane(), Ogre::Entity::EntityShadowRenderable::EntityShadowRenderable(), Ogre::Frustum::Frustum(), Ogre::ShadowCaster::generateShadowVolume(), Ogre::BillboardSet::getRenderOperation(), Ogre::Mesh::getTangentsBuffer(), Ogre::TerrainRenderable::init(), Ogre::PanelGuiElement::initialise(), Ogre::BorderPanelGuiElement::initialise(), Ogre::PatchMesh::load(), Ogre::BspLevel::loadQuake3Level(), Ogre::EdgeListBuilder::log(), Ogre::ProgressiveMesh::ProgressiveMesh(), Ogre::MeshSerializerImpl_v1::readGeometry(), Ogre::MeshSerializerImpl::readGeometry(), Ogre::MeshSerializerImpl::readGeometryColours(), Ogre::MeshSerializerImpl::readGeometryNormals(), Ogre::MeshSerializerImpl::readGeometryPositions(), Ogre::MeshSerializerImpl_v1_1::readGeometryTexCoords(), Ogre::MeshSerializerImpl::readGeometryTexCoords(), Ogre::Rectangle2D::Rectangle2D(), Ogre::BillboardSet::setPoolSize(), Ogre::Mesh::softwareVertexBlend(), Ogre::TextAreaGuiElement::updateGeometry(), Ogre::PanelGuiElement::updateTextureGeometry(), VertexData(), Ogre::WireBoundingBox::WireBoundingBox(), and Ogre::MeshSerializerImpl::writeGeometry().

VertexDeclaration* Ogre::VertexData::vertexDeclaration
 

Declaration of the vertex to be used in this operation.

Remarks:
Note that this is created for you on construction.

Definition at line 49 of file OgreVertexIndexData.h.

Referenced by Ogre::GLRenderSystem::_render(), Ogre::D3D9RenderSystem::_render(), Ogre::D3DRenderSystem::_render(), Ogre::ProgressiveMesh::addWorkingData(), Ogre::Mesh::buildTangentVectors(), Ogre::EdgeListBuilder::buildTrianglesEdges(), Ogre::MeshSerializerImpl::calcGeometrySize(), Ogre::TTYGuiElement::checkMemoryAllocation(), Ogre::TextAreaGuiElement::checkMemoryAllocation(), clone(), Ogre::Entity::cloneVertexDataRemoveBlendInfo(), Ogre::Mesh::compileBoneAssignments(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::MeshManager::createPrefabPlane(), Ogre::Entity::EntityShadowRenderable::EntityShadowRenderable(), Ogre::Entity::extractTempBufferInfo(), Ogre::Frustum::Frustum(), Ogre::Mesh::getTangentsBuffer(), Ogre::TerrainRenderable::init(), Ogre::TTYGuiElement::initialise(), Ogre::TextAreaGuiElement::initialise(), Ogre::PanelGuiElement::initialise(), Ogre::BorderPanelGuiElement::initialise(), Ogre::PatchMesh::load(), Ogre::BspLevel::loadQuake3Level(), Ogre::EdgeListBuilder::log(), prepareForShadowVolume(), Ogre::MeshSerializerImpl_v1::readGeometry(), Ogre::MeshSerializerImpl::readGeometryColours(), Ogre::MeshSerializerImpl::readGeometryNormals(), Ogre::MeshSerializerImpl::readGeometryPositions(), Ogre::MeshSerializerImpl_v1_1::readGeometryTexCoords(), Ogre::MeshSerializerImpl::readGeometryTexCoords(), Ogre::Rectangle2D::Rectangle2D(), Ogre::BillboardSet::setPoolSize(), Ogre::Mesh::softwareVertexBlend(), Ogre::PanelGuiElement::updateTextureGeometry(), VertexData(), Ogre::WireBoundingBox::WireBoundingBox(), Ogre::MeshSerializerImpl::writeGeometry(), and ~VertexData().

size_t Ogre::VertexData::vertexStart
 

The base vertex index to start from, if using unindexed geometry.

Definition at line 55 of file OgreVertexIndexData.h.

Referenced by Ogre::GLRenderSystem::_render(), Ogre::D3D9RenderSystem::_render(), Ogre::D3DRenderSystem::_render(), Ogre::TTYGuiElement::checkAndSetUpdateGeometry(), clone(), Ogre::MeshManager::createCurvedPlane(), Ogre::Entity::EntityShadowRenderable::EntityShadowRenderable(), Ogre::Frustum::Frustum(), Ogre::BillboardSet::getRenderOperation(), Ogre::TerrainRenderable::init(), Ogre::TTYGuiElement::initialise(), Ogre::TextAreaGuiElement::initialise(), Ogre::PanelGuiElement::initialise(), Ogre::BorderPanelGuiElement::initialise(), Ogre::PatchMesh::load(), Ogre::BspLevel::loadQuake3Level(), Ogre::MeshSerializerImpl_v1::readGeometry(), Ogre::MeshSerializerImpl::readGeometry(), Ogre::Rectangle2D::Rectangle2D(), Ogre::BillboardSet::setPoolSize(), VertexData(), and Ogre::WireBoundingBox::WireBoundingBox().


The documentation for this class was generated from the following files:

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:27:27 2004