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

# Ogre::Mesh Class Reference

Resource holding data about 3D mesh. More...

`#include <OgreMesh.h>`

Inheritance diagram for Ogre::Mesh:

[legend]
List of all members.

## Public Types

typedef std::vector< Real > | LodDistanceList
typedef std::multimap< size_t, VertexBoneAssignment > | VertexBoneAssignmentList
| Multimap of vertex bone assignments (orders by vertex index).
typedef MapIterator< VertexBoneAssignmentList > | BoneAssignmentIterator
typedef std::vector< SubMesh * > | SubMeshList
typedef HashMap< String, ushort > | SubMeshNameMap
| A hashmap used to store optional SubMesh names.
typedef VectorIterator< SubMeshList > | SubMeshIterator

## Public Methods

| Mesh (const String &name)
| Default constructor - used by MeshManager.
| ~Mesh ()
virtual void | load (void)
| Generic load - called by MeshManager.
virtual void | unload (void)
| Generic unload - called by MeshManager.
SubMesh * | createSubMesh (void)
| Creates a new SubMesh.
SubMesh * | createSubMesh (const String &name)
| Creates a new SubMesh and gives it a name.
void | nameSubMesh (const String &name, ushort index)
| Gives a name to a SubMesh.
ushort | _getSubMeshIndex (const String &name) const
| Gets the index of a submesh with a given name.
unsigned short | getNumSubMeshes (void) const
| Gets the number of sub meshes which comprise this mesh.
SubMesh * | getSubMesh (unsigned short index) const
| Gets a pointer to the submesh indicated by the index.
SubMesh * | getSubMesh (const String &name) const
| Gets a SubMesh by name.
SubMeshIterator | getSubMeshIterator (void)
| Gets an iterator over the available submeshes.
void | setManuallyDefined (bool manuallyDefined)
| Call this to indicate that this Mesh will be manually defined rather than loaded from a file.
Mesh * | clone (const String &newName)
| Makes a copy of this mesh object and gives it a new name.
const AxisAlignedBox & | getBounds (void) const
| Get the axis-aligned bounding box for this mesh.
Real | getBoundingSphereRadius (void) const
| Gets the radius of the bounding sphere surrounding this mesh.
void | _setBounds (const AxisAlignedBox &bounds, bool pad=true)
| Manually set the bounding box for this Mesh.
void | _setBoundingSphereRadius (Real radius)
| Manually set the bounding radius.
void | setSkeletonName (const String &skelName)
| Sets the name of the skeleton this Mesh uses for animation.
bool | hasSkeleton (void) const
| Returns true if this Mesh has a linked Skeleton.
Skeleton * | getSkeleton (void) const
| Gets a pointer to any linked Skeleton.
const String & | getSkeletonName (void) const
| Gets the name of any linked Skeleton.
void | _initAnimationState (AnimationStateSet *animSet)
| Initialise an animation set suitable for use with this mesh.
void | addBoneAssignment (const VertexBoneAssignment &vertBoneAssign)
| Assigns a vertex to a bone with a given weight, for skeletal animation.
void | clearBoneAssignments (void)
| Removes all bone assignments for this mesh.
void | _notifySkeleton (Skeleton *pSkel)
| Internal notification, used to tell the Mesh which Skeleton to use without loading it.
BoneAssignmentIterator | getBoneAssignmentIterator (void)
| Gets an iterator for access all bone assignments.
void | generateLodLevels (const LodDistanceList &lodDistances, ProgressiveMesh::VertexReductionQuota reductionMethod, Real reductionValue)
| Automatically generates lower level of detail versions of this mesh for use when a simpler version of the model is acceptable for rendering.
ushort | getNumLodLevels (void) const
| Returns the number of levels of detail that this mesh supports.
const MeshLodUsage & | getLodLevel (ushort index) const
| Gets details of the numbered level of detail entry.
void | createManualLodLevel (Real fromDepth, const String &meshName)
| Adds a new manual level-of-detail entry to this Mesh.
void | updateManualLodLevel (ushort index, const String &meshName)
| Changes the alternate mesh to use as a manual LOD at the given index.
ushort | getLodIndex (Real depth) const
| Retrieves the level of detail index for the given depth value.
ushort | getLodIndexSquaredDepth (Real squaredDepth) const
| Retrieves the level of detail index for the given squared depth value.
bool | isLodManual (void) const
| Returns true if this mesh is using manual LOD.
void | _setLodInfo (unsigned short numLevels, bool isManual)
| Internal methods for loading LOD, do not use.
void | _setLodUsage (unsigned short level, Mesh::MeshLodUsage &usage)
| Internal methods for loading LOD, do not use.
void | _setSubMeshLodFaceList (unsigned short subIdx, unsigned short level, IndexData *facedata)
| Internal methods for loading LOD, do not use.
void | removeLodLevels (void)
| Removes all LOD data from this Mesh.
void | setVertexBufferPolicy (HardwareBuffer::Usage usage, bool shadowBuffer=false)
| Sets the policy for the vertex buffers to be used when loading this Mesh.
void | setIndexBufferPolicy (HardwareBuffer::Usage usage, bool shadowBuffer=false)
| Sets the policy for the index buffers to be used when loading this Mesh.
HardwareBuffer::Usage | getVertexBufferUsage (void) const
| Gets the usage setting for this meshes vertex buffers.
HardwareBuffer::Usage | getIndexBufferUsage (void) const
| Gets the usage setting for this meshes index buffers.
bool | isVertexBufferShadowed (void) const
| Gets whether or not this meshes vertex buffers are shadowed.
bool | isIndexBufferShadowed (void) const
| Gets whether or not this meshes index buffers are shadowed.
unsigned short | _rationaliseBoneAssignments (size_t vertexCount, VertexBoneAssignmentList &assignments)
| Rationalises the passed in bone assignment list.
void | _compileBoneAssignments (void)
| Internal method, be called once to compile bone assignments into geometry buffer.
void | buildTangentVectors (unsigned short sourceTexCoordSet=0, unsigned short destTexCoordSet=1)
| This method builds a set of tangent vectors for a given mesh into a 3D texture coordinate buffer.
bool | suggestTangentVectorBuildParams (unsigned short &outSourceCoordSet, unsigned short &outDestCoordSet)
| Ask the mesh to suggest parameters to a future buildTangentVectors call.
void | buildEdgeList (void)
| Builds an edge list for this mesh, which can be used for generating a shadow volume among other things.
void | freeEdgeList (void)
| Destroys and frees the edge lists this mesh has built.
void | prepareForShadowVolume (void)
| This method prepares the mesh for generating a renderable shadow volume.
EdgeData * | getEdgeList (unsigned int lodIndex=0)
| Return the edge list for this mesh, building it if required.
const EdgeData * | getEdgeList (unsigned int lodIndex=0) const
| Return the edge list for this mesh, building it if required.
bool | isPreparedForShadowVolumes (void) const
| Returns whether this mesh has already had it's geometry prepared for use in rendering shadow volumes.
bool | isEdgeListBuilt (void) const
| Returns whether this mesh has an attached edge list.
const SubMeshNameMap & | getSubMeshNameMap (void) const
| Gets a reference to the optional name assignments of the SubMeshes.
void | setAutoBuildEdgeLists (bool autobuild)
| Sets whether or not this Mesh should automatically build edge lists when asked for them, or whether it should never build them if they are not already provided.
bool | getAutoBuildEdgeLists (void) const
| Sets whether or not this Mesh should automatically build edge lists when asked for them, or whether it should never build them if they are not already provided.
virtual size_t | getSize (void) const
| Retrieves info about the size of the resource.
virtual void | touch (void)
| 'Touches' the resource to indicate it has been used.
time_t | getLastAccess (void) const
| Gets the last time the resource was 'touched'.
const String & | getName (void) const
| Gets resource name.
ResourceHandle | getHandle (void) const
bool | isLoaded (void) const
| Returns true if the Resource has been loaded, false otherwise.
virtual void | destroy ()
| A method to make the resource delete itself.

## Static Public Methods

void | softwareVertexBlend (const VertexData *sourceVertexData, const VertexData *targetVertexData, const Matrix4 *pMatrices, bool blendNormals)
| Performs a software indexed vertex blend, of the kind used for skeletal animation although it can be used for other purposes.

## Public Attributes

VertexData * | sharedVertexData
| Shared vertex data.

## Protected Types

typedef std::vector< MeshLodUsage > | MeshLodUsageList

## Protected Methods

void | organiseTangentsBuffer (VertexData *vertexData, unsigned short destCoordSet)
| Internal method for making the space for a 3D texture coord buffer to hold tangents.
void | compileBoneAssignments (const VertexBoneAssignmentList &boneAssignments, unsigned short numBlendWeightsPerVertex, VertexData *targetVertexData)
| Compile bone assignments into blend index and weight buffers.
void | compileBoneAssignmentsSoftware (const VertexBoneAssignmentList &boneAssignments, unsigned short numBlendWeightsPerVertex, VertexData *targetVertexData)
| Software blending oriented bone assignment compilation.

## Protected Attributes

SubMeshList | mSubMeshList
| A list of submeshes which make up this mesh.
SubMeshNameMap | mSubMeshNameMap
AxisAlignedBox | mAABB
| Local bounding box volume.
Real | mBoundRadius
| Local bounding sphere radius (centered on object).
bool | mManuallyDefined
String | mSkeletonName
| Optional linked skeleton.
Skeleton * | mSkeleton
VertexBoneAssignmentList | mBoneAssignments
bool | mBoneAssignmentsOutOfDate
| Flag indicating that bone assignments need to be recompiled.
bool | mIsLodManual
ushort | mNumLods
MeshLodUsageList | mMeshLodUsageList
HardwareBuffer::Usage | mVertexBufferUsage
HardwareBuffer::Usage | mIndexBufferUsage
bool | mVertexBufferShadowBuffer
bool | mIndexBufferShadowBuffer
bool | mPreparedForShadowVolumes
bool | mEdgeListsBuilt
bool | mAutoBuildEdgeLists
String | mName
ResourceHandle | mHandle
bool | mIsLoaded
time_t | mLastAccess
size_t | mSize

## Friends

class | MeshSerializerImpl
class | MeshSerializerImpl_v1_1
class | MeshSerializerImpl_v1_2
class | SubMesh

## Detailed Description

Resource holding data about 3D mesh.

Remarks:
  This class holds the data used to represent a discrete 3-dimensional object. Mesh data usually contains more than just vertices and triangle information; it also includes references to materials (and the faces which use them), level-of-detail reduction information, convex hull definition, skeleton/bones information, keyframe animation etc. However, it is important to note the emphasis on the word 'discrete' here. This class does not cover the large-scale sprawling geometry found in level / landscape data.

  Multiple world objects can (indeed should) be created from a single mesh object - see the Entity class for more info. The mesh object will have it's own default material properties, but potentially each world instance may wish to customise the materials from the original. When the object is instantiated into a scene node, the mesh material properties will be taken by default but may be changed. These properties are actually held at the SubMesh level since a single mesh may have parts with different materials.

  As described above, because the mesh may have sections of differing material properties, a mesh is inherently a compound contruct, consisting of one or more SubMesh objects. However, it strongly 'owns' it's SubMeshes such that they are loaded / unloaded at the same time. This is contrary to the approach taken to hierarchically related (but loosely owned) scene nodes, where data is loaded / unloaded separately. Note also that mesh sub-sections (when used in an instantiated object) share the same scene node as the parent.

Definition at line 79 of file OgreMesh.h.

## Member Typedef Documentation

typedef MapIterator<VertexBoneAssignmentList> Ogre::Mesh::BoneAssignmentIterator

| Definition at line 102 of file OgreMesh.h. Referenced by getBoneAssignmentIterator().

typedef std::vector<Real> Ogre::Mesh::LodDistanceList

| Definition at line 99 of file OgreMesh.h.

typedef std::vector<MeshLodUsage> Ogre::Mesh::MeshLodUsageList`[protected]`

| Definition at line 154 of file OgreMesh.h.

typedef VectorIterator<SubMeshList> Ogre::Mesh::SubMeshIterator

| Definition at line 221 of file OgreMesh.h.

typedef std::vector<SubMesh*> Ogre::Mesh::SubMeshList

| Definition at line 103 of file OgreMesh.h.

typedef HashMap<String, ushort> Ogre::Mesh::SubMeshNameMap

| A hashmap used to store optional SubMesh names. Translates a name into SubMesh index Definition at line 121 of file OgreMesh.h.

typedef std::multimap<size_t, VertexBoneAssignment> Ogre::Mesh::VertexBoneAssignmentList

| Multimap of vertex bone assignments (orders by vertex index). Definition at line 101 of file OgreMesh.h.

## Constructor & Destructor Documentation

Ogre::Mesh::Mesh | ( | const String & | name | ) |

Default constructor - used by MeshManager.

Warning:
  Do not call this method directly.

Definition at line 44 of file OgreMesh.cpp.

References Ogre::Mesh::MeshLodUsage::edgeData, Ogre::Mesh::MeshLodUsage::fromDepthSquared, Ogre::Mesh::MeshLodUsage::manualMesh, mAutoBuildEdgeLists, mBoneAssignmentsOutOfDate, mBoundRadius, mEdgeListsBuilt, mIndexBufferShadowBuffer, mIndexBufferUsage, mIsLodManual, mManuallyDefined, mMeshLodUsageList, Ogre::Resource::mName, mNumLods, mPreparedForShadowVolumes, mVertexBufferShadowBuffer, mVertexBufferUsage, setSkeletonName(), sharedVertexData, and Ogre::String.

Ogre::Mesh::~Mesh | ( |  | ) |

| Definition at line 76 of file OgreMesh.cpp. References unload().

## Member Function Documentation

void Ogre::Mesh::_compileBoneAssignments | ( | void |  | ) |

Internal method, be called once to compile bone assignments into geometry buffer.

Remarks:
  The OGRE engine calls this method automatically. It compiles the information submitted as bone assignments into a format usable in realtime. It also eliminates excessive bone assignments (max is OGRE_MAX_BLEND_WEIGHTS) and re-normalises the remaining assignments.

Definition at line 496 of file OgreMesh.cpp.

References _rationaliseBoneAssignments(), compileBoneAssignments(), mBoneAssignments, mBoneAssignmentsOutOfDate, sharedVertexData, and Ogre::VertexData::vertexCount.

Referenced by _initAnimationState().

ushort Ogre::Mesh::_getSubMeshIndex | ( | const String & | name | ) | const

Gets the index of a submesh with a given name.

Remarks:
  Useful if you identify the SubMeshes by name (using nameSubMesh) but wish to have faster repeat access.

Definition at line 835 of file OgreMesh.cpp.

References Except, mSubMeshNameMap, Ogre::String, and Ogre::ushort.

Referenced by Ogre::Entity::getSubEntity(), and getSubMesh().

void Ogre::Mesh::_initAnimationState | ( | AnimationStateSet * | animSet | ) |

Initialise an animation set suitable for use with this mesh.

Remarks:
  Only recommended for use inside the engine, not by applications.

Definition at line 390 of file OgreMesh.cpp.

References _compileBoneAssignments(), Ogre::Skeleton::_initAnimationState(), Ogre::AnimationStateSet, mSkeleton, and mSubMeshList.

Referenced by Ogre::Entity::Entity().

void Ogre::Mesh::_notifySkeleton | ( | Skeleton * | pSkel | ) |

Internal notification, used to tell the Mesh which Skeleton to use without loading it.

Remarks:
  This is only here for unusual situation where you want to manually set up a Skeleton. Best to let OGRE deal with this, don't call it yourself unless you really know what you're doing.

Definition at line 627 of file OgreMesh.cpp.

References Ogre::Resource::getName(), mSkeleton, and mSkeletonName.

unsigned short Ogre::Mesh::_rationaliseBoneAssignments | ( | size_t | vertexCount,
|  | VertexBoneAssignmentList & | assignments
| ) |

Rationalises the passed in bone assignment list.

Remarks:
  OGRE supports up to 4 bone assignments per vertex. The reason for this limit is that this is the maximum number of assignments that can be passed into a hardware-assisted blending algorithm. This method identifies where there are more than 4 bone assignments for a given vertex, and eliminates the bone assignments with the lowest weights to reduce to this limit. The remaining weights are then re-balanced to ensure that they sum to 1.0.

Parameters:

  vertexCount | The number of vertices.
  assignments | The bone assignment list to rationalise. This list will be modified and entries will be removed where the limits are exceeded.

Returns:
  The maximum number of bone assignments per vertex found, clamped to [1-4]

Definition at line 411 of file OgreMesh.cpp.

References Ogre::Resource::mName, OGRE_MAX_BLEND_WEIGHTS, Ogre::Real, and Ogre::WeightIteratorMap.

Referenced by Ogre::SubMesh::_compileBoneAssignments(), and _compileBoneAssignments().

void Ogre::Mesh::_setBoundingSphereRadius | ( | Real | radius | ) |

Manually set the bounding radius.

Remarks:
  Calling this method is required when building manual meshes now, because OGRE can no longer update the bounds for you, because it cannot necessarily read vertex data back from the vertex buffers which this mesh uses (they very well might be write-only, and even if they are not, reading data from a hardware buffer is a bottleneck).

Definition at line 331 of file OgreMesh.cpp.

References mBoundRadius, and Ogre::Real.

Referenced by Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::MeshManager::createPrefabPlane(), Ogre::PatchMesh::load(), and Ogre::MeshSerializerImpl::readBoundsInfo().

void Ogre::Mesh::_setBounds | ( | const AxisAlignedBox & | bounds,
|  | bool | pad = true
| ) |

Manually set the bounding box for this Mesh.

Remarks:
  Calling this method is required when building manual meshes now, because OGRE can no longer update the bounds for you, because it cannot necessarily read vertex data back from the vertex buffers which this mesh uses (they very well might be write-only, and even if they are not, reading data from a hardware buffer is a bottleneck).

Parameters:

  pad | If true, a certain padding will be added to the bounding box to separate it from the mesh

Definition at line 303 of file OgreMesh.cpp.

References Ogre::AxisAlignedBox::getMaximum(), Ogre::AxisAlignedBox::getMinimum(), mAABB, mBoundRadius, Ogre::Real, Ogre::AxisAlignedBox::setExtents(), and Ogre::Vector3::squaredLength().

Referenced by Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::MeshManager::createPrefabPlane(), Ogre::PatchMesh::load(), and Ogre::MeshSerializerImpl::readBoundsInfo().

void Ogre::Mesh::_setLodInfo | ( | unsigned short | numLevels,
|  | bool | isManual
| ) |

| Internal methods for loading LOD, do not use. Definition at line 791 of file OgreMesh.cpp. References mEdgeListsBuilt, mIsLodManual, mMeshLodUsageList, mNumLods, and mSubMeshList.

void Ogre::Mesh::_setLodUsage | ( | unsigned short | level,
|  | Mesh::MeshLodUsage & | usage
| ) |

| Internal methods for loading LOD, do not use. Definition at line 808 of file OgreMesh.cpp. References mEdgeListsBuilt, and mMeshLodUsageList.

void Ogre::Mesh::_setSubMeshLodFaceList | ( | unsigned short | subIdx,
|  | unsigned short | level,
|  | IndexData * | facedata
| ) |

| Internal methods for loading LOD, do not use. Definition at line 819 of file OgreMesh.cpp. References mEdgeListsBuilt, mIsLodManual, Ogre::SubMesh::mLodFaceList, and mSubMeshList.

void Ogre::Mesh::addBoneAssignment | ( | const VertexBoneAssignment & | vertBoneAssign | ) |

Assigns a vertex to a bone with a given weight, for skeletal animation.

Remarks:
  This method is only valid after calling setSkeletonName. Since this is a one-off process there exists only 'addBoneAssignment' and 'clearBoneAssignments' methods, no 'editBoneAssignment'. You should not need to modify bone assignments during rendering (only the positions of bones) and OGRE reserves the right to do some internal data reformatting of this information, depending on render system requirements.

  This method is for assigning weights to the shared geometry of the Mesh. To assign weights to the per-SubMesh geometry, see the equivalent methods on SubMesh.

Definition at line 377 of file OgreMesh.cpp.

References mBoneAssignments, mBoneAssignmentsOutOfDate, and Ogre::VertexBoneAssignment_s::vertexIndex.

Referenced by Ogre::MeshSerializerImpl::readMeshBoneAssignment().

void Ogre::Mesh::buildEdgeList | ( | void |  | ) |

Builds an edge list for this mesh, which can be used for generating a shadow volume among other things.

Definition at line 1256 of file OgreMesh.cpp.

References Ogre::EdgeListBuilder::addIndexData(), Ogre::EdgeListBuilder::addVertexData(), Ogre::EdgeListBuilder::build(), Ogre::Mesh::MeshLodUsage::edgeData, getEdgeList(), getLodLevel(), Ogre::SubMesh::indexData, Ogre::EdgeData::log(), Ogre::Mesh::MeshLodUsage::manualMesh, mEdgeListsBuilt, mIsLodManual, Ogre::SubMesh::mLodFaceList, mMeshLodUsageList, Ogre::Resource::mName, mSubMeshList, Ogre::SubMesh::operationType, sharedVertexData, Ogre::SubMesh::useSharedVertices, and Ogre::SubMesh::vertexData.

Referenced by getEdgeList(), and load().

void Ogre::Mesh::buildTangentVectors | ( | unsigned short | sourceTexCoordSet = 0,
|  | unsigned short | destTexCoordSet = 1
| ) |

This method builds a set of tangent vectors for a given mesh into a 3D texture coordinate buffer.

Remarks:
  Tangent vectors are vectors representing the local 'X' axis for a given vertex based on the orientation of the 2D texture on the geometry. They are built from a combination of existing normals, and from the 2D texture coordinates already baked into the model. They can be used for a number of things, but most of all they are useful for vertex and fragment programs, when you wish to arrive at a common space for doing per-pixel calculations.

  The prerequisites for calling this method include that the vertex data used by every SubMesh has both vertex normals and 2D texture coordinates.

Parameters:

  sourceTexCoordSet | The texture coordinate index which should be used as the source of 2D texture coordinates, with which to calculate the tangents.
  destTexCoordSet | The texture coordinate set which should be used to store the 3D coordinates representing a tangent vector per vertex. If this already exists, it will be overwritten.

Definition at line 972 of file OgreMesh.cpp.

References Ogre::VertexElement::baseVertexPointerToElement(), Except, Ogre::VertexDeclaration::findElementBySemantic(), Ogre::VertexBufferBinding::getBuffer(), getNumSubMeshes(), Ogre::VertexElement::getSource(), getSubMesh(), Ogre::VertexElement::getType(), Ogre::IndexData::indexBuffer, Ogre::IndexData::indexCount, Ogre::SubMesh::indexData, Ogre::SharedPtr< HardwareVertexBuffer >::isNull(), Ogre::Resource::mName, Ogre::Vector3::normalise(), organiseTangentsBuffer(), Ogre::Real, sharedVertexData, Ogre::SubMesh::useSharedVertices, Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::SubMesh::vertexData, Ogre::VertexData::vertexDeclaration, Ogre::VES_POSITION, Ogre::VES_TEXTURE_COORDINATES, Ogre::VET_FLOAT2, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

void Ogre::Mesh::clearBoneAssignments | ( | void |  | ) |

Removes all bone assignments for this mesh.

Remarks:
  This method is for modifying weights to the shared geometry of the Mesh. To assign weights to the per-SubMesh geometry, see the equivalent methods on SubMesh.

Definition at line 384 of file OgreMesh.cpp.

References mBoneAssignments, and mBoneAssignmentsOutOfDate.

Mesh * Ogre::Mesh::clone | ( | const String & | newName | ) |

Makes a copy of this mesh object and gives it a new name.

Remarks:
  This is useful if you want to tweak an existing mesh without affecting the original one. The newly cloned mesh is registered with the MeshManager under the new name.

Definition at line 213 of file OgreMesh.cpp.

References Ogre::IndexData::clone(), Ogre::VertexData::clone(), createSubMesh(), Ogre::Mesh::MeshLodUsage::edgeData, Ogre::SubMesh::indexData, load(), mAABB, mBoneAssignments, Ogre::SubMesh::mBoneAssignments, mBoneAssignmentsOutOfDate, Ogre::SubMesh::mBoneAssignmentsOutOfDate, mBoundRadius, mIndexBufferShadowBuffer, mIndexBufferUsage, mIsLodManual, Ogre::SubMesh::mLodFaceList, Ogre::SubMesh::mMaterialName, Ogre::SubMesh::mMatInitialised, mMeshLodUsageList, mNumLods, mSkeleton, mSkeletonName, mSubMeshList, mSubMeshNameMap, mVertexBufferShadowBuffer, mVertexBufferUsage, Ogre::SubMesh::operationType, sharedVertexData, Ogre::String, Ogre::Resource::touch(), Ogre::SubMesh::useSharedVertices, and Ogre::SubMesh::vertexData.

void Ogre::Mesh::compileBoneAssignments | ( | const VertexBoneAssignmentList & | boneAssignments,
|  | unsigned short | numBlendWeightsPerVertex,
|  | VertexData * | targetVertexData
| ) | `[protected]`

Compile bone assignments into blend index and weight buffers.

Definition at line 513 of file OgreMesh.cpp.

References Ogre::VertexDeclaration::addElement(), Ogre::VertexElement::baseVertexPointerToElement(), Ogre::VertexDeclaration::findElementBySemantic(), Ogre::VertexDeclaration::getElement(), Ogre::VertexDeclaration::getElementCount(), Ogre::VertexBufferBinding::getNextIndex(), Ogre::VertexElement::getSemantic(), Ogre::VertexElement::getSource(), Ogre::VertexDeclaration::insertElement(), Ogre::Real, Ogre::VertexDeclaration::removeElement(), Ogre::VertexBufferBinding::setBinding(), Ogre::VertexBufferBinding::unsetBinding(), Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::VertexData::vertexDeclaration, Ogre::VES_BLEND_INDICES, Ogre::VES_BLEND_WEIGHTS, Ogre::VES_POSITION, Ogre::VET_FLOAT1, and Ogre::VET_UBYTE4.

Referenced by Ogre::SubMesh::_compileBoneAssignments(), and _compileBoneAssignments().

void Ogre::Mesh::compileBoneAssignmentsSoftware | ( | const VertexBoneAssignmentList & | boneAssignments,
|  | unsigned short | numBlendWeightsPerVertex,
|  | VertexData * | targetVertexData
| ) | `[protected]`

| Software blending oriented bone assignment compilation.

void Ogre::Mesh::createManualLodLevel | ( | Real | fromDepth,
|  | const String & | meshName
| ) |

Adds a new manual level-of-detail entry to this Mesh.

Remarks:
  As an alternative to generating lower level of detail versions of a mesh, you can use your own manually modelled meshes as lower level versions. This lets you have complete control over the LOD, and in addition lets you scale down other aspects of the model which cannot be done using the generated method; for example, you could use less detailed materials and / or use less bones in the skeleton if this is an animated mesh. Therefore for complex models you are likely to be better off modelling your LODs yourself and using this method, whilst for models with fairly simple materials and no animation you can just use the generateLodLevels method.

Parameters:

  fromDepth | The z value from which this Lod will apply.
  meshName | The name of the mesh which will be the lower level detail version.

Definition at line 732 of file OgreMesh.cpp.

References Ogre::Mesh::MeshLodUsage::edgeData, Ogre::Mesh::MeshLodUsage::fromDepthSquared, Ogre::Mesh::MeshLodUsage::manualMesh, Ogre::Mesh::MeshLodUsage::manualName, mIsLodManual, mMeshLodUsageList, mNumLods, Ogre::Real, and Ogre::String.

SubMesh * Ogre::Mesh::createSubMesh | ( | const String & | name | ) |

| Creates a new SubMesh and gives it a name. Definition at line 95 of file OgreMesh.cpp. References createSubMesh(), mSubMeshList, nameSubMesh(), Ogre::String, and Ogre::ushort.

SubMesh * Ogre::Mesh::createSubMesh | ( | void |  | ) |

Creates a new SubMesh.

Remarks:
  Method for manually creating geometry for the mesh. Note - use with extreme caution - you must be sure that you have set up the geometry properly.

Definition at line 85 of file OgreMesh.cpp.

References mSubMeshList, Ogre::SubMesh::parent, and SubMesh.

Referenced by clone(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::MeshManager::createPrefabPlane(), createSubMesh(), Ogre::PatchMesh::load(), and Ogre::MeshSerializerImpl::readSubMesh().

virtual void Ogre::Resource::destroy | ( | void |  | ) | `[virtual, inherited]`

A method to make the resource delete itself.

Note:
  This exists because Resource objects could be created in other processes, and they need to be destroyed in the process that created them.

Definition at line 137 of file OgreResource.h.

void Ogre::Mesh::freeEdgeList | ( | void |  | ) |

| Destroys and frees the edge lists this mesh has built. Definition at line 1339 of file OgreMesh.cpp. References Ogre::Mesh::MeshLodUsage::edgeData, mEdgeListsBuilt, mIsLodManual, and mMeshLodUsageList. Referenced by removeLodLevels().

void Ogre::Mesh::generateLodLevels | ( | const LodDistanceList & | lodDistances,
|  | ProgressiveMesh::VertexReductionQuota | reductionMethod,
|  | Real | reductionValue
| ) |

Automatically generates lower level of detail versions of this mesh for use when a simpler version of the model is acceptable for rendering.

Remarks:
  There are 2 ways that you can create level-of-detail (LOD) versions of a mesh; the first is to call this method, which does fairly extensive calculations to work out how to simplify the mesh whilst having the minimum affect on the model. The alternative is to actually create simpler versions of the mesh yourself in a modelling tool, and having exported them, tell the 'master' mesh to use these alternative meshes for lower detail versions; this is done by calling the createManualLodLevel method.

  As well as creating the lower detail versions of the mesh, this method will also associate them with depth values. As soon as an object is at least as far away from the camera as the depth value associated with it's LOD, it will drop to that level of detail.

  I recommend calling this method before mesh export, not at runtime.

Parameters:

  lodDistances | A list of depth values indicating the distances at which new lods should be generated.
  reductionMethod | The way to determine the number of vertices collapsed per LOD
  reductionValue | Meaning depends on reductionMethod, typically either the proportion of remaining vertices to collapse or a fixed number of vertices.

Definition at line 644 of file OgreMesh.cpp.

References Ogre::ProgressiveMesh::build(), Ogre::Mesh::MeshLodUsage::edgeData, Ogre::Mesh::MeshLodUsage::fromDepthSquared, Ogre::Mesh::MeshLodUsage::manualMesh, mMeshLodUsageList, Ogre::Resource::mName, mNumLods, mSubMeshList, Ogre::Real, removeLodLevels(), and sharedVertexData.

bool Ogre::Mesh::getAutoBuildEdgeLists | ( | void |  | ) | const

| Sets whether or not this Mesh should automatically build edge lists when asked for them, or whether it should never build them if they are not already provided. Definition at line 626 of file OgreMesh.h. Referenced by Ogre::Entity::Entity().

Mesh::BoneAssignmentIterator Ogre::Mesh::getBoneAssignmentIterator | ( | void |  | ) |

| Gets an iterator for access all bone assignments. Definition at line 633 of file OgreMesh.cpp. References BoneAssignmentIterator, and mBoneAssignments.

Real Ogre::Mesh::getBoundingSphereRadius | ( | void |  | ) | const

| Gets the radius of the bounding sphere surrounding this mesh. Definition at line 874 of file OgreMesh.cpp. References mBoundRadius, and Ogre::Real. Referenced by Ogre::MeshSerializerImpl::exportMesh(), and Ogre::Entity::getBoundingRadius().

const AxisAlignedBox & Ogre::Mesh::getBounds | ( | void |  | ) | const

| Get the axis-aligned bounding box for this mesh. Definition at line 298 of file OgreMesh.cpp. References mAABB. Referenced by Ogre::MeshSerializerImpl::exportMesh(), and Ogre::Entity::getBoundingBox().

const EdgeData * Ogre::Mesh::getEdgeList | ( | unsigned int | lodIndex = 0 | ) | const

Return the edge list for this mesh, building it if required.

Remarks:
  You must ensure that the Mesh as been prepared for shadow volume rendering if you intend to use this information for that purpose. @lodIndex The LOD at which to get the edge list, 0 being the highest.

Definition at line 1397 of file OgreMesh.cpp.

References Ogre::Mesh::MeshLodUsage::edgeData, and getLodLevel().

EdgeData * Ogre::Mesh::getEdgeList | ( | unsigned int | lodIndex = 0 | ) |

Return the edge list for this mesh, building it if required.

Remarks:
  You must ensure that the Mesh as been prepared for shadow volume rendering if you intend to use this information for that purpose. @lodIndex The LOD at which to get the edge list, 0 being the highest.

Definition at line 1386 of file OgreMesh.cpp.

References buildEdgeList(), Ogre::Mesh::MeshLodUsage::edgeData, getLodLevel(), mAutoBuildEdgeLists, and mEdgeListsBuilt.

Referenced by buildEdgeList(), Ogre::MeshSerializerImpl::calcEdgeListSize(), Ogre::Entity::getEdgeList(), and Ogre::MeshSerializerImpl::writeEdgeList().

ResourceHandle Ogre::Resource::getHandle | ( | void |  | ) | const`[inherited]`

| Definition at line 120 of file OgreResource.h. References Ogre::ResourceHandle. Referenced by Ogre::Material::clone(), Ogre::BspLevel::loadQuake3Level(), and Ogre::ResourceManager::unload().

HardwareBuffer::Usage Ogre::Mesh::getIndexBufferUsage | ( | void |  | ) | const

| Gets the usage setting for this meshes index buffers. Definition at line 475 of file OgreMesh.h.

time_t Ogre::Resource::getLastAccess | ( | void |  | ) | const`[inherited]`

| Gets the last time the resource was 'touched'. Definition at line 108 of file OgreResource.h.

ushort Ogre::Mesh::getLodIndex | ( | Real | depth | ) | const

| Retrieves the level of detail index for the given depth value. Definition at line 767 of file OgreMesh.cpp. References getLodIndexSquaredDepth(), Ogre::Real, and Ogre::ushort.

ushort Ogre::Mesh::getLodIndexSquaredDepth | ( | Real | squaredDepth | ) | const

Retrieves the level of detail index for the given squared depth value.

Remarks:
  Internally the lods are stored at squared depths to avoid having to perform square roots when determining the lod. This method allows you to provide a squared length depth value to avoid having to do your own square roots.

Definition at line 772 of file OgreMesh.cpp.

References mMeshLodUsageList, Ogre::Real, and Ogre::ushort.

Referenced by Ogre::Entity::_notifyCurrentCamera(), and getLodIndex().

const Mesh::MeshLodUsage & Ogre::Mesh::getLodLevel | ( | ushort | index | ) | const

| Gets details of the numbered level of detail entry. Definition at line 701 of file OgreMesh.cpp. References mIsLodManual, mMeshLodUsageList, and Ogre::ushort. Referenced by buildEdgeList(), Ogre::Entity::cacheBoneMatrices(), Ogre::Entity::Entity(), getEdgeList(), Ogre::MeshSerializerImpl::readEdgeList(), and Ogre::MeshSerializerImpl::writeLodInfo().

const String& Ogre::Resource::getName | ( | void |  | ) | const`[inherited]`

Gets resource name.

Reimplemented in Ogre::Material, and Ogre::Overlay.

Definition at line 115 of file OgreResource.h.

References Ogre::String.

Referenced by Ogre::D3D9Texture::_loadCubeTex(), _notifySkeleton(), Ogre::ResourceManager::add(), Ogre::PopupMenuGuiElement::addListItem(), Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::MeshManager::createPrefabPlane(), Ogre::TTYGuiElement::getFontName(), Ogre::TextAreaGuiElement::getFontName(), Ogre::PopupMenuGuiElement::getListItemName(), Ogre::ListGuiElement::getListItemName(), Ogre::GpuProgramUsage::getProgramName(), Ogre::MeshSerializer::importMesh(), Ogre::GLTexture::load(), Ogre::TextureManager::loadImage(), Ogre::TextureManager::loadRawData(), Ogre::FontManager::logBadAttrib(), Ogre::MeshSerializerImpl::readMeshLodInfo(), Ogre::MeshSerializerImpl::readMeshLodUsageGenerated(), Ogre::MeshSerializerImpl::readMeshLodUsageManual(), Ogre::PopupMenuGuiElement::removeListItem(), Ogre::ListGuiElement::removeListItem(), Ogre::SceneManager::setSkyBox(), Ogre::SceneManager::setSkyDome(), and Ogre::ResourceManager::unload().

ushort Ogre::Mesh::getNumLodLevels | ( | void |  | ) | const

Returns the number of levels of detail that this mesh supports.

Remarks:
  This number includes the original model.

Definition at line 696 of file OgreMesh.cpp.

References mNumLods, and Ogre::ushort.

Referenced by Ogre::MeshSerializerImpl::calcEdgeListSize(), Ogre::Entity::Entity(), Ogre::MeshSerializerImpl::writeEdgeList(), Ogre::MeshSerializerImpl::writeLodInfo(), and Ogre::MeshSerializerImpl::writeMesh().

unsigned short Ogre::Mesh::getNumSubMeshes | ( | void |  | ) | const

Gets the number of sub meshes which comprise this mesh.

Definition at line 102 of file OgreMesh.cpp.

References mSubMeshList.

Referenced by Ogre::Entity::buildSubEntityList(), buildTangentVectors(), Ogre::MeshSerializerImpl::calcMeshSize(), Ogre::MeshSerializerImpl::readMeshLodInfo(), Ogre::MeshSerializerImpl::readMeshLodUsageGenerated(), Ogre::MeshSerializerImpl::writeLodUsageGenerated(), and Ogre::MeshSerializerImpl::writeMesh().

virtual size_t Ogre::Resource::getSize | ( | void |  | ) | const`[virtual, inherited]`

| Retrieves info about the size of the resource. Definition at line 93 of file OgreResource.h. Referenced by Ogre::ResourceManager::unload().

Skeleton * Ogre::Mesh::getSkeleton | ( | void |  | ) | const

| Gets a pointer to any linked Skeleton. Definition at line 372 of file OgreMesh.cpp. References mSkeleton. Referenced by Ogre::Entity::Entity(), and Ogre::Entity::shareSkeletonInstanceWith().

const String & Ogre::Mesh::getSkeletonName | ( | void |  | ) | const

| Gets the name of any linked Skeleton. Definition at line 639 of file OgreMesh.cpp. References mSkeletonName, and Ogre::String. Referenced by Ogre::MeshSerializerImpl::calcMeshSize(), and Ogre::MeshSerializerImpl::writeMesh().

SubMesh * Ogre::Mesh::getSubMesh | ( | const String & | name | ) | const

| Gets a SubMesh by name. Definition at line 114 of file OgreMesh.cpp. References _getSubMeshIndex(), getSubMesh(), Ogre::String, and Ogre::ushort.

SubMesh * Ogre::Mesh::getSubMesh | ( | unsigned short | index | ) | const

Gets a pointer to the submesh indicated by the index.

Definition at line 120 of file OgreMesh.cpp.

References mSubMeshList.

Referenced by Ogre::Entity::buildSubEntityList(), buildTangentVectors(), Ogre::MeshSerializerImpl::calcMeshSize(), Ogre::Node::getRenderOperation(), getSubMesh(), Ogre::MeshSerializerImpl::readEdgeList(), Ogre::MeshSerializerImpl::readMeshLodInfo(), Ogre::MeshSerializerImpl::readMeshLodUsageGenerated(), Ogre::PatchMesh::setSubdivision(), Ogre::MeshSerializerImpl::writeLodUsageGenerated(), and Ogre::MeshSerializerImpl::writeMesh().

SubMeshIterator Ogre::Mesh::getSubMeshIterator | ( | void |  | ) |

| Gets an iterator over the available submeshes. Definition at line 223 of file OgreMesh.h.

const SubMeshNameMap& Ogre::Mesh::getSubMeshNameMap | ( | void |  | ) | const

| Gets a reference to the optional name assignments of the SubMeshes. Definition at line 609 of file OgreMesh.h.

HardwareBuffer::Usage Ogre::Mesh::getVertexBufferUsage | ( | void |  | ) | const

| Gets the usage setting for this meshes vertex buffers. Definition at line 473 of file OgreMesh.h. Referenced by Ogre::MeshSerializerImpl_v1_1::readGeometryTexCoords().

bool Ogre::Mesh::hasSkeleton | ( | void |  | ) | const

| Returns true if this Mesh has a linked Skeleton. Definition at line 367 of file OgreMesh.cpp. References mSkeletonName. Referenced by Ogre::Entity::cacheBoneMatrices(), Ogre::MeshSerializerImpl::calcMeshSize(), Ogre::Entity::Entity(), and Ogre::MeshSerializerImpl::writeMesh().

bool Ogre::Mesh::isEdgeListBuilt | ( | void |  | ) | const

| Returns whether this mesh has an attached edge list. Definition at line 587 of file OgreMesh.h. Referenced by Ogre::MeshSerializerImpl::calcMeshSize(), Ogre::Entity::Entity(), and Ogre::MeshSerializerImpl::writeMesh().

bool Ogre::Mesh::isIndexBufferShadowed | ( | void |  | ) | const

| Gets whether or not this meshes index buffers are shadowed. Definition at line 479 of file OgreMesh.h.

bool Ogre::Resource::isLoaded | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource has been loaded, false otherwise. Definition at line 127 of file OgreResource.h. Referenced by Ogre::GpuProgramUsage::_load(), Ogre::SceneManager::deriveShadowCasterPass(), Ogre::SceneManager::deriveShadowReceiverPass(), Ogre::Technique::isLoaded(), Ogre::D3D9Texture::load(), Ogre::D3D9Texture::unload(), and Ogre::D3D9Texture::~D3D9Texture().

bool Ogre::Mesh::isLodManual | ( | void |  | ) | const

Returns true if this mesh is using manual LOD.

Remarks:
  A mesh can either use automatically generated LOD, or it can use alternative meshes as provided by an artist. A mesh can only use either all manual LODs or all generated LODs, not a mixture of both.

Definition at line 414 of file OgreMesh.h.

Referenced by Ogre::Entity::_updateRenderQueue(), Ogre::Entity::cacheBoneMatrices(), Ogre::MeshSerializerImpl::calcEdgeListSize(), Ogre::Entity::Entity(), Ogre::Entity::getShadowVolumeRenderableIterator(), Ogre::MeshSerializerImpl::readMeshLodInfo(), Ogre::Entity::setRenderQueueGroup(), Ogre::MeshSerializerImpl::writeEdgeList(), and Ogre::MeshSerializerImpl::writeLodInfo().

bool Ogre::Mesh::isPreparedForShadowVolumes | ( | void |  | ) | const

| Returns whether this mesh has already had it's geometry prepared for use in rendering shadow volumes. Definition at line 584 of file OgreMesh.h. Referenced by Ogre::Entity::getShadowVolumeRenderableIterator().

bool Ogre::Mesh::isVertexBufferShadowed | ( | void |  | ) | const

| Gets whether or not this meshes vertex buffers are shadowed. Definition at line 477 of file OgreMesh.h. Referenced by Ogre::MeshSerializerImpl_v1_1::readGeometryTexCoords().

void Ogre::Mesh::load | ( | void |  | ) | `[virtual]`

Generic load - called by MeshManager.

Implements Ogre::Resource.

Reimplemented in Ogre::PatchMesh.

Definition at line 126 of file OgreMesh.cpp.

References buildEdgeList(), Ogre::DataChunk::clear(), Except, Ogre::MeshSerializer::importMesh(), mAutoBuildEdgeLists, mEdgeListsBuilt, Ogre::Resource::mIsLoaded, mManuallyDefined, Ogre::Resource::mName, prepareForShadowVolume(), Ogre::String, and unload().

Referenced by clone(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), and Ogre::MeshManager::createPlane().

void Ogre::Mesh::nameSubMesh | ( | const String & | name,
|  | ushort | index
| ) |

| Gives a name to a SubMesh. Definition at line 108 of file OgreMesh.cpp. References mSubMeshNameMap, Ogre::String, and Ogre::ushort. Referenced by createSubMesh(), and Ogre::MeshSerializerImpl::readSubMeshNameTable().

void Ogre::Mesh::organiseTangentsBuffer | ( | VertexData * | vertexData,
|  | unsigned short | destCoordSet
| ) | `[protected]`

Internal method for making the space for a 3D texture coord buffer to hold tangents.

Definition at line 891 of file OgreMesh.cpp.

References Ogre::VertexDeclaration::addElement(), Except, Ogre::VertexDeclaration::findElementBySemantic(), Ogre::VertexBufferBinding::getBuffer(), Ogre::VertexElement::getSource(), Ogre::VertexElement::getType(), Ogre::VertexBufferBinding::setBinding(), Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::VertexData::vertexDeclaration, Ogre::VES_TEXTURE_COORDINATES, and Ogre::VET_FLOAT3.

Referenced by buildTangentVectors().

void Ogre::Mesh::prepareForShadowVolume | ( | void |  | ) |

This method prepares the mesh for generating a renderable shadow volume.

Remarks:
  Preparing a mesh to generate a shadow volume involves firstly ensuring that the vertex buffer containing the positions for the mesh is a standalone vertex buffer, with no other components in it. This method will therefore break apart any existing vertex buffers this mesh holds 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 of the mesh. The vertex count of the main VertexData used to render the mesh 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.

  Because shadow volumes are rendered in turn, no additional index buffer space is allocated by this method, a shared index buffer allocated by the shadow rendering algorithm is used for addressing this extended vertex buffer.

Definition at line 1364 of file OgreMesh.cpp.

References mPreparedForShadowVolumes, mSubMeshList, Ogre::VertexData::prepareForShadowVolume(), sharedVertexData, Ogre::SubMesh::useSharedVertices, and Ogre::SubMesh::vertexData.

Referenced by Ogre::Entity::getShadowVolumeRenderableIterator(), and load().

void Ogre::Mesh::removeLodLevels | ( | void |  | ) |

| Removes all LOD data from this Mesh. Definition at line 845 of file OgreMesh.cpp. References Ogre::Mesh::MeshLodUsage::edgeData, freeEdgeList(), Ogre::Mesh::MeshLodUsage::fromDepthSquared, Ogre::Mesh::MeshLodUsage::manualMesh, mIsLodManual, mMeshLodUsageList, mNumLods, and mSubMeshList. Referenced by generateLodLevels(), and unload().

void Ogre::Mesh::setAutoBuildEdgeLists | ( | bool | autobuild | ) |

Sets whether or not this Mesh should automatically build edge lists when asked for them, or whether it should never build them if they are not already provided.

Remarks:
  This allows you to create meshes which do not have edge lists calculated, because you never want to use them. This value defaults to 'true' for mesh formats which did not include edge data, and 'false' for newer formats, where edge lists are expected to have been generated in advance.

Definition at line 621 of file OgreMesh.h.

void Ogre::Mesh::setIndexBufferPolicy | ( | HardwareBuffer::Usage | usage,
|  | bool | shadowBuffer = false
| ) |

Sets the policy for the index buffers to be used when loading this Mesh.

Remarks:
  By default, when loading the Mesh, static, write-only vertex and index buffers will be used where possible in order to improve rendering performance. However, such buffers cannot be manipulated on the fly by CPU code (although shader code can). If you wish to use the CPU to modify these buffers, you should call this method. Note, however, that it only takes effect after the Mesh has been reloaded. Note that you still have the option of manually repacing the buffers in this mesh with your own if you see fit too, in which case you don't need to call this method since it only affects buffers created by the mesh itself.

  You can define the approach to a Mesh by changing the default parameters to MeshManager::load if you wish; this means the Mesh is loaded with those options the first time instead of you having to reload the mesh after changing these options.

Parameters:

  usage | The usage flags, which by default are HardwareBuffer::HBU_STATIC_WRITE_ONLY
  shadowBuffer | If set to true, the index buffers will be created with a system memory shadow buffer. You should set this if you want to be able to read from the buffer, because reading from a hardware buffer is a no-no.

Definition at line 885 of file OgreMesh.cpp.

References mIndexBufferShadowBuffer, and mIndexBufferUsage.

Referenced by Ogre::MeshManager::load().

void Ogre::Mesh::setManuallyDefined | ( | bool | manuallyDefined | ) |

Call this to indicate that this Mesh will be manually defined rather than loaded from a file.

Remarks:
  Normally, when load() is called on a Resource such as a Mesh, a file of data is loaded. However, by calling this method with a parameter of 'true' you are indicating that the contents of this Mesh will be defined programmatically rather than by loading from a file. Note that the load() method must still be called in order to confirm the Mesh's use for the renderer, set up materials etc.

Definition at line 207 of file OgreMesh.cpp.

References mManuallyDefined.

Referenced by Ogre::MeshManager::createBezierPatch(), and Ogre::MeshManager::createManual().

void Ogre::Mesh::setSkeletonName | ( | const String & | skelName | ) |

Sets the name of the skeleton this Mesh uses for animation.

Remarks:
  Meshes can optionally be assigned a skeleton which can be used to animate the mesh through bone assignments. The default is for the Mesh to use no skeleton. Calling this method with a valid skeleton filename will cause the skeleton to be loaded if it is not already (a single skeleton can be shared by many Mesh objects).

Parameters:

  skelName | The name of the .skeleton file to use, or an empty string to use no skeleton

Definition at line 336 of file OgreMesh.cpp.

References Ogre::Skeleton::load(), Ogre::Resource::mName, mSkeleton, mSkeletonName, and Ogre::String.

Referenced by Mesh(), and Ogre::MeshSerializerImpl::readSkeletonLink().

void Ogre::Mesh::setVertexBufferPolicy | ( | HardwareBuffer::Usage | usage,
|  | bool | shadowBuffer = false
| ) |

Sets the policy for the vertex buffers to be used when loading this Mesh.

Remarks:
  By default, when loading the Mesh, static, write-only vertex and index buffers will be used where possible in order to improve rendering performance. However, such buffers cannot be manipulated on the fly by CPU code (although shader code can). If you wish to use the CPU to modify these buffers, you should call this method. Note, however, that it only takes effect after the Mesh has been reloaded. Note that you still have the option of manually repacing the buffers in this mesh with your own if you see fit too, in which case you don't need to call this method since it only affects buffers created by the mesh itself.

  You can define the approach to a Mesh by changing the default parameters to MeshManager::load if you wish; this means the Mesh is loaded with those options the first time instead of you having to reload the mesh after changing these options.

Parameters:

  usage | The usage flags, which by default are HardwareBuffer::HBU_STATIC_WRITE_ONLY
  shadowBuffer | If set to true, the vertex buffers will be created with a system memory shadow buffer. You should set this if you want to be able to read from the buffer, because reading from a hardware buffer is a no-no.

Definition at line 879 of file OgreMesh.cpp.

References mVertexBufferShadowBuffer, and mVertexBufferUsage.

Referenced by Ogre::MeshManager::load().

void Ogre::Mesh::softwareVertexBlend | ( | const VertexData * | sourceVertexData,
|  | const VertexData * | targetVertexData,
|  | const Matrix4 * | pMatrices,
|  | bool | blendNormals
| ) | `[static]`

Performs a software indexed vertex blend, of the kind used for skeletal animation although it can be used for other purposes.

Remarks:
  This function is supplied to update vertex data with blends done in software, either because no hardware support is available, or that you need the results of the blend for some other CPU operations.

Parameters:

  sourceVertexData | VertexData class containing positions, normals, blend indices and blend weights.
  targetVertexData | VertexData class containing target position and normal buffers which will be updated with the blended versions. Note that the layout of the source and target position / normal buffers must be identical, ie they must use the same buffer indexes
  pMatrices | Pointer to an array of matrices to be used to blend
  blendNormals | If true, normals are blended as well as positions

Definition at line 1402 of file OgreMesh.cpp.

References Ogre::VertexElement::baseVertexPointerToElement(), Ogre::VertexDeclaration::findElementBySemantic(), Ogre::SharedPtr< HardwareVertexBuffer >::get(), Ogre::VertexBufferBinding::getBuffer(), Ogre::VertexElement::getOffset(), Ogre::VertexElement::getSize(), Ogre::VertexElement::getSource(), Ogre::VertexElement::getType(), Ogre::Vector3::normalise(), Ogre::Real, Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::VertexData::vertexDeclaration, Ogre::VES_BLEND_INDICES, Ogre::VES_BLEND_WEIGHTS, Ogre::VES_NORMAL, Ogre::VES_POSITION, Ogre::VET_UBYTE4, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

bool Ogre::Mesh::suggestTangentVectorBuildParams | ( | unsigned short & | outSourceCoordSet,
|  | unsigned short & | outDestCoordSet
| ) |

Ask the mesh to suggest parameters to a future buildTangentVectors call.

Remarks:
  This helper method will suggest source and destination texture coordinate sets for a call to buildTangentVectors. It will detect when there are inappropriate conditions (such as multiple geometry sets which don't agree). Moreover, it will return 'true' if it detects that there are aleady 3D coordinates in the mesh, and therefore tangents may have been prepared already.

Parameters:

  outSourceCoordSet | Reference to a source texture coordinate set which will be populated
  outDestCoordSet | Reference to a destination texture coordinate set which will be populated

Definition at line 1154 of file OgreMesh.cpp.

References Except, Ogre::VertexDeclaration::findElementBySemantic(), Ogre::VertexElement::getIndex(), Ogre::VertexElement::getType(), mSubMeshList, OGRE_MAX_TEXTURE_COORD_SETS, sharedVertexData, Ogre::SubMesh::useSharedVertices, Ogre::SubMesh::vertexData, Ogre::VertexData::vertexDeclaration, Ogre::VES_TEXTURE_COORDINATES, Ogre::VET_FLOAT2, and Ogre::VET_FLOAT3.

virtual void Ogre::Resource::touch | ( | void |  | ) | `[virtual, inherited]`

| 'Touches' the resource to indicate it has been used. Reimplemented in Ogre::Material. Definition at line 100 of file OgreResource.h. Referenced by clone(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), and Ogre::ResourceManager::load().

void Ogre::Mesh::unload | ( | void |  | ) | `[virtual]`

| Generic unload - called by MeshManager. Reimplemented from Ogre::Resource. Definition at line 184 of file OgreMesh.cpp. References Ogre::Resource::mIsLoaded, mPreparedForShadowVolumes, mSubMeshList, mSubMeshNameMap, removeLodLevels(), and sharedVertexData. Referenced by load(), and ~Mesh().

void Ogre::Mesh::updateManualLodLevel | ( | ushort | index,
|  | const String & | meshName
| ) |

Changes the alternate mesh to use as a manual LOD at the given index.

Remarks:
  Note that the index of a LOD may change if you insert other LODs. If in doubt, use getLodIndex().

Parameters:

  index | The index of the level to be changed
  meshName | The name of the mesh which will be the lower level detail version.

Definition at line 751 of file OgreMesh.cpp.

References Ogre::Mesh::MeshLodUsage::edgeData, Ogre::Mesh::MeshLodUsage::manualMesh, Ogre::Mesh::MeshLodUsage::manualName, mIsLodManual, mMeshLodUsageList, Ogre::String, and Ogre::ushort.

## Friends And Related Function Documentation

friend class MeshSerializerImpl`[friend]`

| Definition at line 81 of file OgreMesh.h.

friend class MeshSerializerImpl_v1_1`[friend]`

| Definition at line 82 of file OgreMesh.h.

friend class MeshSerializerImpl_v1_2`[friend]`

| Definition at line 83 of file OgreMesh.h.

friend class SubMesh`[friend]`

| Definition at line 84 of file OgreMesh.h. Referenced by createSubMesh().

## Member Data Documentation

AxisAlignedBox Ogre::Mesh::mAABB`[protected]`

| Local bounding box volume. Definition at line 126 of file OgreMesh.h. Referenced by _setBounds(), clone(), getBounds(), and Ogre::MeshSerializerImpl::writeBoundsInfo().

bool Ogre::Mesh::mAutoBuildEdgeLists`[protected]`

| Definition at line 165 of file OgreMesh.h. Referenced by getEdgeList(), load(), Mesh(), Ogre::MeshSerializerImpl_v1_2::readMesh(), and Ogre::MeshSerializerImpl::readMesh().

VertexBoneAssignmentList Ogre::Mesh::mBoneAssignments`[protected]`

| Definition at line 138 of file OgreMesh.h. Referenced by _compileBoneAssignments(), addBoneAssignment(), clearBoneAssignments(), clone(), getBoneAssignmentIterator(), and Ogre::MeshSerializerImpl::writeMesh().

bool Ogre::Mesh::mBoneAssignmentsOutOfDate`[protected]`

| Flag indicating that bone assignments need to be recompiled. Definition at line 141 of file OgreMesh.h. Referenced by _compileBoneAssignments(), addBoneAssignment(), clearBoneAssignments(), clone(), and Mesh().

Real Ogre::Mesh::mBoundRadius`[protected]`

| Local bounding sphere radius (centered on object). Definition at line 128 of file OgreMesh.h. Referenced by _setBoundingSphereRadius(), _setBounds(), clone(), getBoundingSphereRadius(), Mesh(), and Ogre::MeshSerializerImpl::writeBoundsInfo().

bool Ogre::Mesh::mEdgeListsBuilt`[protected]`

| Definition at line 164 of file OgreMesh.h. Referenced by _setLodInfo(), _setLodUsage(), _setSubMeshLodFaceList(), buildEdgeList(), freeEdgeList(), getEdgeList(), load(), Mesh(), and Ogre::MeshSerializerImpl::readEdgeList().

ResourceHandle Ogre::Resource::mHandle`[protected, inherited]`

| Definition at line 57 of file OgreResource.h. Referenced by Ogre::ResourceManager::add(), Ogre::Material::clone(), Ogre::Material::copyDetailsTo(), and Ogre::Material::operator=().

bool Ogre::Mesh::mIndexBufferShadowBuffer`[protected]`

| Definition at line 160 of file OgreMesh.h. Referenced by clone(), Ogre::PatchMesh::load(), Mesh(), Ogre::PatchMesh::PatchMesh(), Ogre::MeshSerializerImpl_v1_2::readGeometryPositions(), Ogre::MeshSerializerImpl::readMeshLodUsageGenerated(), Ogre::MeshSerializerImpl::readSubMesh(), and setIndexBufferPolicy().

HardwareBuffer::Usage Ogre::Mesh::mIndexBufferUsage`[protected]`

| Definition at line 158 of file OgreMesh.h. Referenced by clone(), Ogre::PatchMesh::load(), Mesh(), Ogre::PatchMesh::PatchMesh(), Ogre::MeshSerializerImpl::readMeshLodUsageGenerated(), Ogre::MeshSerializerImpl::readSubMesh(), and setIndexBufferPolicy().

bool Ogre::Resource::mIsLoaded`[protected, inherited]`

Definition at line 58 of file OgreResource.h.

Referenced by Ogre::D3D9Texture::_initMembers(), Ogre::D3D9Texture::_loadCubeTex(), Ogre::D3D9Texture::_loadNormTex(), Ogre::D3D9Texture::_loadVolumeTex(), Ogre::Material::_notifyNeedsRecompile(), Ogre::Material::clone(), Ogre::D3DTexture::createSurface2D(), Ogre::D3DTexture::createSurface3D(), Ogre::D3D9Texture::D3D9Texture(), Ogre::D3DTexture::D3DTexture(), Ogre::DynLib::DynLib(), Ogre::Zip::load(), Ogre::SkeletonInstance::load(), Ogre::Skeleton::load(), Ogre::PatchMesh::load(), load(), Ogre::Material::load(), Ogre::HighLevelGpuProgram::load(), Ogre::GpuProgram::load(), Ogre::GLTexture::load(), Ogre::GLSLGpuProgram::load(), Ogre::Font::load(), Ogre::DynLib::load(), Ogre::D3D9Texture::load(), Ogre::D3D9GpuProgram::load(), Ogre::D3DTexture::load(), Ogre::BspLevel::load(), Ogre::D3D9Texture::loadImage(), Ogre::D3DTexture::loadImage(), Ogre::D3DTexture::loadImage3D(), Ogre::GLTexture::loadImages(), Ogre::Material::Material(), Ogre::Material::operator=(), Ogre::Skeleton::unload(), unload(), Ogre::Material::unload(), Ogre::HighLevelGpuProgram::unload(), Ogre::GLTexture::unload(), Ogre::Font::unload(), Ogre::DynLib::unload(), Ogre::D3D9Texture::unload(), Ogre::D3DTexture::unload(), and Ogre::BspLevel::~BspLevel().

bool Ogre::Mesh::mIsLodManual`[protected]`

| Definition at line 152 of file OgreMesh.h. Referenced by _setLodInfo(), _setSubMeshLodFaceList(), buildEdgeList(), clone(), createManualLodLevel(), freeEdgeList(), getLodLevel(), Mesh(), Ogre::MeshSerializerImpl::readMeshLodInfo(), removeLodLevels(), and updateManualLodLevel().

time_t Ogre::Resource::mLastAccess`[protected, inherited]`

| Definition at line 59 of file OgreResource.h. Referenced by Ogre::Material::operator=().

bool Ogre::Mesh::mManuallyDefined`[protected]`

| Definition at line 130 of file OgreMesh.h. Referenced by load(), Mesh(), and setManuallyDefined().

MeshLodUsageList Ogre::Mesh::mMeshLodUsageList`[protected]`

| Definition at line 155 of file OgreMesh.h. Referenced by _setLodInfo(), _setLodUsage(), buildEdgeList(), clone(), createManualLodLevel(), freeEdgeList(), generateLodLevels(), getLodIndexSquaredDepth(), getLodLevel(), Mesh(), Ogre::MeshSerializerImpl::readMeshLodInfo(), removeLodLevels(), and updateManualLodLevel().

String Ogre::Resource::mName`[protected, inherited]`

Definition at line 56 of file OgreResource.h.

Referenced by Ogre::Skeleton::_dumpContents(), _rationaliseBoneAssignments(), Ogre::GLSLProgram::attachToProgramObject(), Ogre::BspLevel::BspLevel(), buildEdgeList(), buildTangentVectors(), Ogre::Material::clone(), Ogre::Material::compile(), Ogre::GLSLProgram::compile(), Ogre::Material::copyDetailsTo(), Ogre::Quake3Shader::createAsMaterial(), Ogre::D3D9HLSLProgram::createLowLevelImpl(), Ogre::CgProgram::createLowLevelImpl(), Ogre::Font::createTextureFromFont(), Ogre::D3D9Texture::D3D9Texture(), Ogre::D3DTexture::D3DTexture(), Ogre::DynLib::DynLib(), Ogre::Font::Font(), generateLodLevels(), Ogre::Material::getBestTechnique(), Ogre::Overlay::getName(), Ogre::Material::getName(), Ogre::GLTexture::GLTexture(), Ogre::GpuProgram::GpuProgram(), Ogre::Zip::load(), Ogre::Skeleton::load(), load(), Ogre::GLTexture::load(), Ogre::Font::load(), Ogre::DynLib::load(), Ogre::D3DTexture::load(), Ogre::BspLevel::load(), Ogre::D3D9GpuFragmentProgram::loadFromMicrocode(), Ogre::D3D9GpuVertexProgram::loadFromMicrocode(), Ogre::GLSLProgram::loadFromSource(), Ogre::GLArbGpuProgram::loadFromSource(), Ogre::D3D9HLSLProgram::loadFromSource(), Ogre::D3D9GpuProgram::loadFromSource(), Ogre::CgProgram::loadFromSource(), Ogre::GLTexture::loadImages(), Ogre::Material::Material(), Mesh(), Ogre::Material::operator=(), Ogre::Overlay::Overlay(), Ogre::Quake3Shader::Quake3Shader(), Ogre::CgProgram::selectProfile(), setSkeletonName(), Ogre::Skeleton::Skeleton(), Ogre::StringResource::StringResource(), Ogre::Texture::Texture(), Ogre::Zip::unload(), Ogre::DynLib::unload(), Ogre::CgProgram::unloadImpl(), and Ogre::Zip::Zip().

ushort Ogre::Mesh::mNumLods`[protected]`

| Definition at line 153 of file OgreMesh.h. Referenced by _setLodInfo(), clone(), createManualLodLevel(), generateLodLevels(), getNumLodLevels(), Mesh(), Ogre::MeshSerializerImpl::readMeshLodInfo(), and removeLodLevels().

bool Ogre::Mesh::mPreparedForShadowVolumes`[protected]`

| Definition at line 163 of file OgreMesh.h. Referenced by Mesh(), prepareForShadowVolume(), and unload().

size_t Ogre::Resource::mSize`[protected, inherited]`

| Definition at line 60 of file OgreResource.h. Referenced by Ogre::D3D9Texture::_setFinalAttributes(), Ogre::D3DTexture::loadImage(), Ogre::D3DTexture::loadImage3D(), Ogre::GLTexture::loadImages(), and Ogre::Material::operator=().

Skeleton* Ogre::Mesh::mSkeleton`[protected]`

| Definition at line 135 of file OgreMesh.h. Referenced by _initAnimationState(), _notifySkeleton(), clone(), getSkeleton(), and setSkeletonName().

String Ogre::Mesh::mSkeletonName`[protected]`

| Optional linked skeleton. Definition at line 134 of file OgreMesh.h. Referenced by _notifySkeleton(), clone(), getSkeletonName(), hasSkeleton(), and setSkeletonName().

SubMeshList Ogre::Mesh::mSubMeshList`[protected]`

A list of submeshes which make up this mesh.

Each mesh is made up of 1 or more submeshes, which are each based on a single material and can have their own vertex data (they may not - they can share vertex data from the Mesh, depending on preference).

Definition at line 112 of file OgreMesh.h.

Referenced by _initAnimationState(), _setLodInfo(), _setSubMeshLodFaceList(), buildEdgeList(), clone(), createSubMesh(), generateLodLevels(), getNumSubMeshes(), getSubMesh(), prepareForShadowVolume(), removeLodLevels(), suggestTangentVectorBuildParams(), and unload().

SubMeshNameMap Ogre::Mesh::mSubMeshNameMap`[protected]`

| Definition at line 123 of file OgreMesh.h. Referenced by _getSubMeshIndex(), Ogre::MeshSerializerImpl::calcSubMeshNameTableSize(), clone(), nameSubMesh(), unload(), and Ogre::MeshSerializerImpl::writeSubMeshNameTable().

bool Ogre::Mesh::mVertexBufferShadowBuffer`[protected]`

| Definition at line 159 of file OgreMesh.h. Referenced by clone(), Ogre::PatchMesh::load(), Mesh(), Ogre::PatchMesh::PatchMesh(), Ogre::MeshSerializerImpl_v1_2::readGeometryColours(), Ogre::MeshSerializerImpl_v1_2::readGeometryNormals(), Ogre::MeshSerializerImpl_v1_2::readGeometryTexCoords(), Ogre::MeshSerializerImpl::readGeometryVertexBuffer(), and setVertexBufferPolicy().

HardwareBuffer::Usage Ogre::Mesh::mVertexBufferUsage`[protected]`

Definition at line 157 of file OgreMesh.h.

Referenced by clone(), Ogre::PatchMesh::load(), Mesh(), Ogre::PatchMesh::PatchMesh(), Ogre::MeshSerializerImpl_v1_2::readGeometryColours(), Ogre::MeshSerializerImpl_v1_2::readGeometryNormals(), Ogre::MeshSerializerImpl_v1_2::readGeometryPositions(), Ogre::MeshSerializerImpl_v1_2::readGeometryTexCoords(), Ogre::MeshSerializerImpl::readGeometryVertexBuffer(), and setVertexBufferPolicy().

VertexData* Ogre::Mesh::sharedVertexData

Shared vertex data.

Remarks:
  This vertex data can be shared among multiple submeshes. SubMeshes may not have their own VertexData, they may share this one.

  The use of shared or non-shared buffers is determined when model data is converted to the OGRE .mesh format.

Definition at line 234 of file OgreMesh.h.

Referenced by _compileBoneAssignments(), Ogre::SubMesh::_getRenderOperation(), buildEdgeList(), buildTangentVectors(), Ogre::MeshSerializerImpl::calcMeshSize(), clone(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::MeshManager::createPrefabPlane(), Ogre::Entity::findBlendedVertexData(), Ogre::Entity::findSubEntityForVertexData(), generateLodLevels(), Ogre::Entity::getShadowVolumeRenderableIterator(), Mesh(), prepareForShadowVolume(), Ogre::Entity::prepareTempBlendBuffers(), Ogre::MeshSerializerImpl::readEdgeList(), Ogre::MeshSerializerImpl::readMesh(), suggestTangentVectorBuildParams(), unload(), Ogre::Entity::updateAnimation(), and Ogre::MeshSerializerImpl::writeMesh().

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

- OgreMesh.h
- OgreMesh.cpp

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:13 2004