| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Public Types | Public Member Functions | Public Attributes | Friends | List of all members
Ogre::SubMesh Class Reference
Core » Resources

Defines a part of a complete mesh. More...

`#include <OgreSubMesh.h>`

Inheritance diagram for Ogre::SubMesh:
[legend]

## Public Types
typedef ConstMapIterator< AliasTextureNamePairList > | AliasTextureIterator
typedef MapIterator< VertexBoneAssignmentList > | BoneAssignmentIterator
typedef std::vector< unsigned short > | IndexMap
| Dedicated index map for translate blend index to bone index (only valid if useSharedVertices = false). More...
typedef std::vector< IndexData * > | LODFaceList
typedef std::multimap< size_t, VertexBoneAssignment > | VertexBoneAssignmentList
| Multimap of verex bone assignments (orders by vertex index) More...

## Public Member Functions
| SubMesh ()
| ~SubMesh ()
void | _compileBoneAssignments (void)
| Must be called once to compile bone assignments into geometry buffer. More...
void | _getRenderOperation (RenderOperation &rend, ushort lodIndex=0)
| Returns a RenderOperation structure required to render this mesh. More...
void | addBoneAssignment (const VertexBoneAssignment &vertBoneAssign)
| Assigns a vertex to a bone with a given weight, for skeletal animation. More...
void | addTextureAlias (const String &aliasName, const String &textureName)
| Adds the alias or replaces an existing one and associates the texture name to it. More...
void | clearBoneAssignments (void)
| Removes all bone assignments for this mesh. More...
SubMesh * | clone (const String &newName, Mesh *parentMesh=0)
| Makes a copy of this submesh object and gives it a new name. More...
void | generateExtremes (size_t count)
| Generate the submesh extremes (. More...
AliasTextureIterator | getAliasTextureIterator (void) const
| Gets an constant iterator to access all texture alias names assigned to this submesh. More...
BoneAssignmentIterator | getBoneAssignmentIterator (void)
| Gets an iterator for access all bone assignments. More...
const VertexBoneAssignmentList & | getBoneAssignments ()
| Gets a const reference to the list of bone assignments. More...
const String & | getMaterialName (void) const
size_t | getTextureAliasCount (void) const
| Gets the number of texture aliases assigned to the sub mesh. More...
bool | getVertexAnimationIncludesNormals () const
| Returns whether animation on dedicated vertex data includes normals. More...
VertexAnimationType | getVertexAnimationType (void) const
| Get the type of any vertex animation used by dedicated geometry. More...
bool | hasTextureAliases (void) const
| returns true if the sub mesh has texture aliases More...
bool | isBuildEdgesEnabled (void) const
| Returns true(by default) if the submesh should be included in the mesh EdgeList, otherwise returns false. More...
bool | isMatInitialised (void) const
| Returns true if a material has been assigned to the submesh, otherwise returns false. More...
void | removeAllTextureAliases (void)
| removes all texture aliases from the sub mesh More...
void | removeTextureAlias (const String &aliasName)
| Remove a specific texture alias name from the sub mesh. More...
void | setBuildEdgesEnabled (bool b)
void | setMaterialName (const String &matName, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| Sets the name of the Material which this SubMesh will use. More...
bool | updateMaterialUsingTextureAliases (void)
| The current material used by the submesh is copied into a new material and the submesh's texture aliases are applied if the current texture alias names match those found in the original material. More...

## Public Attributes
IndexMap | blendIndexToBoneIndexMap
std::vector< Vector3 > | extremityPoints
| A list of extreme points on the submesh (optional). More...
IndexData * | indexData
| Face index data. More...
LODFaceList | mLodFaceList
RenderOperation::OperationType | operationType
| The render operation type used to render this submesh. More...
Mesh * | parent
| Reference to parent Mesh (not a smart pointer so child does not keep parent alive). More...
bool | useSharedVertices
| Indicates if this submesh shares vertex data with other meshes or whether it has it's own vertices. More...
VertexData * | vertexData
| Dedicated vertex data (only valid if useSharedVertices = false). More...

## Friends
class | Mesh
class | MeshSerializerImpl
class | MeshSerializerImpl_v1_1
class | MeshSerializerImpl_v1_2

## Detailed Description

Defines a part of a complete mesh.

Remarks
  Meshes which make up the definition of a discrete 3D object are made up of potentially multiple parts. This is because different parts of the mesh may use different materials or use different vertex formats, such that a rendering state change is required between them.

  Like the Mesh class, instantiations of 3D objects in the scene share the SubMesh instances, and have the option of overriding their material differences on a per-object basis if required. See the SubEntity class for more information.

## Member Typedef Documentation

## ◆ IndexMap

typedef std::vector<unsigned short> Ogre::SubMesh::IndexMap

Dedicated index map for translate blend index to bone index (only valid if useSharedVertices = false).

Remarks
  This data is completely owned by this submesh.

  We collect actually used bones of all bone assignments, and build the blend index in 'packed' form, then the range of the blend index in vertex data VES_BLEND_INDICES element is continuous, with no gaps. Thus, by minimising the world matrix array constants passing to GPU, we can support more bones for a mesh when hardware skinning is used. The hardware skinning support limit is applied to each set of vertex data in the mesh, in other words, the hardware skinning support limit is applied only to the actually used bones of each SubMeshes, not all bones across the entire Mesh.

  Because the blend index is different to the bone index, therefore, we use the index map to translate the blend index to bone index.

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

## ◆ LODFaceList

typedef std::vector<IndexData*> Ogre::SubMesh::LODFaceList

## ◆ VertexBoneAssignmentList

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

Multimap of verex bone assignments (orders by vertex index)

## ◆ BoneAssignmentIterator

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

## ◆ AliasTextureIterator

typedef ConstMapIterator<AliasTextureNamePairList> Ogre::SubMesh::AliasTextureIterator

## Constructor & Destructor Documentation

## ◆ SubMesh()

Ogre::SubMesh::SubMesh | ( |  | ) |

## ◆ ~SubMesh()

Ogre::SubMesh::~SubMesh | ( |  | ) |

## Member Function Documentation

## ◆ setMaterialName()

void Ogre::SubMesh::setMaterialName | ( | const String & | matName,
|  | const String & | groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
| ) |  |

Sets the name of the Material which this SubMesh will use.

## ◆ getMaterialName()

const String& Ogre::SubMesh::getMaterialName | ( | void |  | ) | const

## ◆ isMatInitialised()

bool Ogre::SubMesh::isMatInitialised | ( | void |  | ) | const

Returns true if a material has been assigned to the submesh, otherwise returns false.

## ◆ _getRenderOperation()

void Ogre::SubMesh::_getRenderOperation | ( | RenderOperation & | rend,
|  | ushort | lodIndex = `0`
| ) |  |

Returns a RenderOperation structure required to render this mesh.

Parameters

  rend | Reference to a RenderOperation structure to populate.
  lodIndex | The index of the LOD to use.

## ◆ addBoneAssignment()

void Ogre::SubMesh::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 dedicated geometry of the SubMesh. To assign weights to the shared Mesh geometry, see the equivalent methods on Mesh.

## ◆ clearBoneAssignments()

void Ogre::SubMesh::clearBoneAssignments | ( | void |  | ) |

Removes all bone assignments for this mesh.

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

## ◆ getBoneAssignmentIterator()

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

Gets an iterator for access all bone assignments.

Remarks
  Only valid if this SubMesh has dedicated geometry.

## ◆ getBoneAssignments()

const VertexBoneAssignmentList& Ogre::SubMesh::getBoneAssignments | ( |  | ) |
| inline

Gets a const reference to the list of bone assignments.

## ◆ _compileBoneAssignments()

void Ogre::SubMesh::_compileBoneAssignments | ( | void |  | ) |

Must be called once to compile bone assignments into geometry buffer.

## ◆ getAliasTextureIterator()

AliasTextureIterator Ogre::SubMesh::getAliasTextureIterator | ( | void |  | ) | const

Gets an constant iterator to access all texture alias names assigned to this submesh.

## ◆ addTextureAlias()

void Ogre::SubMesh::addTextureAlias | ( | const String & | aliasName,
|  | const String & | textureName
| ) |  |

Adds the alias or replaces an existing one and associates the texture name to it.

Remarks
  The submesh uses the texture alias to replace textures used in the material applied to the submesh.

Parameters

  aliasName | is the name of the alias.
  textureName | is the name of the texture to be associated with the alias

## ◆ removeTextureAlias()

void Ogre::SubMesh::removeTextureAlias | ( | const String & | aliasName | ) |

Remove a specific texture alias name from the sub mesh.

Parameters

  aliasName | is the name of the alias to be removed. If it is not found then it is ignored.

## ◆ removeAllTextureAliases()

void Ogre::SubMesh::removeAllTextureAliases | ( | void |  | ) |

removes all texture aliases from the sub mesh

## ◆ hasTextureAliases()

bool Ogre::SubMesh::hasTextureAliases | ( | void |  | ) | const
| inline

returns true if the sub mesh has texture aliases

## ◆ getTextureAliasCount()

size_t Ogre::SubMesh::getTextureAliasCount | ( | void |  | ) | const
| inline

Gets the number of texture aliases assigned to the sub mesh.

## ◆ updateMaterialUsingTextureAliases()

bool Ogre::SubMesh::updateMaterialUsingTextureAliases | ( | void |  | ) |

The current material used by the submesh is copied into a new material and the submesh's texture aliases are applied if the current texture alias names match those found in the original material.

Remarks
  The submesh's texture aliases must be setup prior to calling this method. If a new material has to be created, the subMesh autogenerates the new name. The new name is the old name + "_" + number.

Returns
  True if texture aliases were applied and a new material was created.

## ◆ getVertexAnimationType()

VertexAnimationType Ogre::SubMesh::getVertexAnimationType | ( | void |  | ) | const

Get the type of any vertex animation used by dedicated geometry.

## ◆ getVertexAnimationIncludesNormals()

bool Ogre::SubMesh::getVertexAnimationIncludesNormals | ( |  | ) | const
| inline

Returns whether animation on dedicated vertex data includes normals.

## ◆ generateExtremes()

void Ogre::SubMesh::generateExtremes | ( | size_t | count | ) |

Generate the submesh extremes (.

See also
  extremityPoints).

Parameters

  count | Number of extreme points to compute for the submesh.

## ◆ isBuildEdgesEnabled()

bool Ogre::SubMesh::isBuildEdgesEnabled | ( | void |  | ) | const
| inline

Returns true(by default) if the submesh should be included in the mesh EdgeList, otherwise returns false.

## ◆ setBuildEdgesEnabled()

void Ogre::SubMesh::setBuildEdgesEnabled | ( | bool | b | ) |

## ◆ clone()

SubMesh* Ogre::SubMesh::clone | ( | const String & | newName,
|  | Mesh * | parentMesh = `0`
| ) |  |

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

Parameters

  newName | The name to give the clone.
  parentMesh | Optional mesh to make the parent of the newly created clone. If you leave this blank, the clone will be parented to the same Mesh as the original.

## Friends And Related Function Documentation

## ◆ Mesh

friend class Mesh
| friend

## ◆ MeshSerializerImpl

friend class MeshSerializerImpl
| friend

## ◆ MeshSerializerImpl_v1_2

friend class MeshSerializerImpl_v1_2
| friend

## ◆ MeshSerializerImpl_v1_1

friend class MeshSerializerImpl_v1_1
| friend

## Member Data Documentation

## ◆ useSharedVertices

bool Ogre::SubMesh::useSharedVertices

Indicates if this submesh shares vertex data with other meshes or whether it has it's own vertices.

Referenced by Ogre::Lod0Stripifier::StripLod0Vertices().

## ◆ operationType

RenderOperation::OperationType Ogre::SubMesh::operationType

The render operation type used to render this submesh.

## ◆ vertexData

VertexData* Ogre::SubMesh::vertexData

Dedicated vertex data (only valid if useSharedVertices = false).

Remarks
  This data is completely owned by this submesh.

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

Referenced by Ogre::Lod0Stripifier::StripLod0Vertices().

## ◆ indexData

IndexData* Ogre::SubMesh::indexData

Face index data.

Referenced by Ogre::Lod0Stripifier::StripLod0Vertices().

## ◆ blendIndexToBoneIndexMap

IndexMap Ogre::SubMesh::blendIndexToBoneIndexMap

## ◆ mLodFaceList

LODFaceList Ogre::SubMesh::mLodFaceList

Referenced by Ogre::Lod0Stripifier::StripLod0Vertices().

## ◆ extremityPoints

std::vector<Vector3> Ogre::SubMesh::extremityPoints

A list of extreme points on the submesh (optional).

Remarks
  These points are some arbitrary points on the mesh that are used by engine to better sort submeshes by depth. This doesn't matter much for non-transparent submeshes, as Z-buffer takes care of invisible surface culling anyway, but is pretty useful for semi-transparent submeshes because the order in which transparent submeshes must be rendered cannot be always correctly deduced from entity position.

  These points are intelligently chosen from the points that make up the submesh, the criteria for choosing them should be that these points somewhat characterize the submesh outline, e.g. they should not be close to each other, and they should be on the outer hull of the submesh. They can be stored in the .mesh file, or generated at runtime (see generateExtremes ()).

  If this array is empty, submesh sorting is done like in older versions - by comparing the positions of the owning entity.

## ◆ parent

Mesh* Ogre::SubMesh::parent

Reference to parent Mesh (not a smart pointer so child does not keep parent alive).

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

- OgreSubMesh.h