OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::SubMesh Class Reference

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

#include <OgreSubMesh.h>

+ Inheritance diagram for Ogre::SubMesh:
+ Collaboration diagram for Ogre::SubMesh:

Public Types

typedef ConstMapIterator
< AliasTextureNamePairList
AliasTextureIterator
 
typedef MapIterator
< VertexBoneAssignmentList
BoneAssignmentIterator
 
typedef FastArray< unsigned short > IndexMap
 Dedicated index map for translate blend index to bone index (only valid if useSharedVertices = false). More...
 
typedef vector< IndexData * >::type LODFaceList
 
typedef multimap< size_t,
VertexBoneAssignment >::type 
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...
 
SubMeshclone (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 VertexBoneAssignmentListgetBoneAssignments ()
 Gets a const reference to the list of bone assignments. More...
 
const StringgetMaterialName (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 operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
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
 
vector< Vector3 >::type extremityPoints
 A list of extreme points on the submesh (optional). More...
 
IndexDataindexData
 Face index data. More...
 
LODFaceList mLodFaceList
 
RenderOperation::OperationType operationType
 The render operation type used to render this submesh. More...
 
Meshparent
 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...
 
VertexDatavertexData
 Dedicated vertex data (only valid if useSharedVertices = false). More...
 

Protected Member Functions

void removeLodLevels (void)
 Internal method for removing LOD data. More...
 

Protected Attributes

VertexBoneAssignmentList mBoneAssignments
 
bool mBoneAssignmentsOutOfDate
 Flag indicating that bone assignments need to be recompiled. More...
 
bool mBuildEdgesEnabled
 Is Build Edges Enabled. More...
 
String mMaterialName
 Name of the material this SubMesh uses. More...
 
bool mMatInitialised
 Is there a material yet? More...
 
AliasTextureNamePairList mTextureAliases
 paired list of texture aliases and texture names More...
 
bool mVertexAnimationIncludesNormals
 Whether normals are included in vertex animation keyframes. More...
 
VertexAnimationType mVertexAnimationType
 Type of vertex animation for dedicated vertex data (populated by Mesh) 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.

Definition at line 60 of file OgreSubMesh.h.

Member Typedef Documentation

typedef FastArray<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.

Definition at line 108 of file OgreSubMesh.h.

Definition at line 111 of file OgreSubMesh.h.

Multimap of verex bone assignments (orders by vertex index)

Definition at line 176 of file OgreSubMesh.h.

Constructor & Destructor Documentation

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

Member Function Documentation

void Ogre::SubMesh::_compileBoneAssignments ( void  )

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

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

Returns a RenderOperation structure required to render this mesh.

Parameters
rendReference to a RenderOperation structure to populate.
lodIndexThe index of the LOD to use.
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.
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
aliasNameis the name of the alias.
textureNameis the name of the texture to be associated with the alias
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.
SubMesh* Ogre::SubMesh::clone ( const String newName,
Mesh parentMesh = 0 
)

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

Parameters
newNameThe name to give the clone.
parentMeshOptional 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.
void Ogre::SubMesh::generateExtremes ( size_t  count)

Generate the submesh extremes (.

See also
extremityPoints).
Parameters
countNumber of extreme points to compute for the submesh.
AliasTextureIterator Ogre::SubMesh::getAliasTextureIterator ( void  ) const

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

BoneAssignmentIterator Ogre::SubMesh::getBoneAssignmentIterator ( void  )

Gets an iterator for access all bone assignments.

Remarks
Only valid if this SubMesh has dedicated geometry.
const VertexBoneAssignmentList& Ogre::SubMesh::getBoneAssignments ( )
inline

Gets a const reference to the list of bone assignments.

Definition at line 187 of file OgreSubMesh.h.

const String& Ogre::SubMesh::getMaterialName ( void  ) const
size_t Ogre::SubMesh::getTextureAliasCount ( void  ) const
inline

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

Definition at line 223 of file OgreSubMesh.h.

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

Returns whether animation on dedicated vertex data includes normals.

Definition at line 242 of file OgreSubMesh.h.

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

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

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

returns true if the sub mesh has texture aliases

Definition at line 220 of file OgreSubMesh.h.

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

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

Definition at line 253 of file OgreSubMesh.h.

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

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

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::SubMesh::removeAllTextureAliases ( void  )

removes all texture aliases from the sub mesh

void Ogre::SubMesh::removeLodLevels ( void  )
protected

Internal method for removing LOD data.

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

Remove a specific texture alias name from the sub mesh.

Parameters
aliasNameis the name of the alias to be removed. If it is not found then it is ignored.
void Ogre::SubMesh::setBuildEdgesEnabled ( bool  b)
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.

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.

Friends And Related Function Documentation

friend class Mesh
friend

Definition at line 62 of file OgreSubMesh.h.

friend class MeshSerializerImpl
friend

Definition at line 63 of file OgreSubMesh.h.

friend class MeshSerializerImpl_v1_1
friend

Definition at line 65 of file OgreSubMesh.h.

friend class MeshSerializerImpl_v1_2
friend

Definition at line 64 of file OgreSubMesh.h.

Member Data Documentation

IndexMap Ogre::SubMesh::blendIndexToBoneIndexMap

Definition at line 109 of file OgreSubMesh.h.

vector<Vector3>::type 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.

Definition at line 133 of file OgreSubMesh.h.

IndexData* Ogre::SubMesh::indexData

Face index data.

Definition at line 87 of file OgreSubMesh.h.

VertexBoneAssignmentList Ogre::SubMesh::mBoneAssignments
protected

Definition at line 275 of file OgreSubMesh.h.

bool Ogre::SubMesh::mBoneAssignmentsOutOfDate
protected

Flag indicating that bone assignments need to be recompiled.

Definition at line 278 of file OgreSubMesh.h.

bool Ogre::SubMesh::mBuildEdgesEnabled
protected

Is Build Edges Enabled.

Definition at line 287 of file OgreSubMesh.h.

LODFaceList Ogre::SubMesh::mLodFaceList

Definition at line 112 of file OgreSubMesh.h.

String Ogre::SubMesh::mMaterialName
protected

Name of the material this SubMesh uses.

Definition at line 267 of file OgreSubMesh.h.

bool Ogre::SubMesh::mMatInitialised
protected

Is there a material yet?

Definition at line 270 of file OgreSubMesh.h.

AliasTextureNamePairList Ogre::SubMesh::mTextureAliases
protected

paired list of texture aliases and texture names

Definition at line 273 of file OgreSubMesh.h.

bool Ogre::SubMesh::mVertexAnimationIncludesNormals
mutableprotected

Whether normals are included in vertex animation keyframes.

Definition at line 284 of file OgreSubMesh.h.

VertexAnimationType Ogre::SubMesh::mVertexAnimationType
mutableprotected

Type of vertex animation for dedicated vertex data (populated by Mesh)

Definition at line 281 of file OgreSubMesh.h.

RenderOperation::OperationType Ogre::SubMesh::operationType

The render operation type used to render this submesh.

Definition at line 75 of file OgreSubMesh.h.

Mesh* Ogre::SubMesh::parent

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

Definition at line 136 of file OgreSubMesh.h.

bool Ogre::SubMesh::useSharedVertices

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

Definition at line 72 of file OgreSubMesh.h.

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.

Definition at line 84 of file OgreSubMesh.h.


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