OgreSubMesh.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __SubMesh_H_
29 #define __SubMesh_H_
30 
31 #include "OgrePrerequisites.h"
32 
33 #include "OgreVertexIndexData.h"
34 #include "OgreMaterial.h"
35 #include "OgreRenderOperation.h"
37 #include "OgreAnimationTrack.h"
39 #include "OgreHeaderPrefix.h"
40 
41 namespace Ogre {
42 
62  class _OgreExport SubMesh : public SubMeshAlloc
63  {
64  friend class Mesh;
65  friend class MeshSerializerImpl;
68  public:
69  SubMesh();
70  ~SubMesh();
71 
72 
75 
78 
87 
90 
112 
115 
136 
139 
141  void setMaterialName(const String& matName, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );
142  const String& getMaterialName(void) const;
143 
146  bool isMatInitialised(void) const;
147 
154  void _getRenderOperation(RenderOperation& rend, ushort lodIndex = 0);
155 
168  void addBoneAssignment(const VertexBoneAssignment& vertBoneAssign);
169 
175  void clearBoneAssignments(void);
176 
180 
185  BoneAssignmentIterator getBoneAssignmentIterator(void);
186 
189  const VertexBoneAssignmentList& getBoneAssignments() { return mBoneAssignments; }
190 
191 
193  void _compileBoneAssignments(void);
194 
199  AliasTextureIterator getAliasTextureIterator(void) const;
210  void addTextureAlias(const String& aliasName, const String& textureName);
216  void removeTextureAlias(const String& aliasName);
219  void removeAllTextureAliases(void);
222  bool hasTextureAliases(void) const { return !mTextureAliases.empty(); }
225  size_t getTextureAliasCount(void) const { return mTextureAliases.size(); }
226 
237  bool updateMaterialUsingTextureAliases(void);
238 
241  VertexAnimationType getVertexAnimationType(void) const;
242 
244  bool getVertexAnimationIncludesNormals() const { return mVertexAnimationIncludesNormals; }
245 
246 
251  void generateExtremes(size_t count);
252 
255  bool isBuildEdgesEnabled(void) const { return mBuildEdgesEnabled; }
256  void setBuildEdgesEnabled(bool b);
264  SubMesh * clone(const String& newName, Mesh *parentMesh = 0);
265 
266  protected:
267 
270 
273 
276 
278 
281 
284 
287 
290 
292  void removeLodLevels(void);
293 
294 
295  };
299 } // namespace
300 
301 #include "OgreHeaderSuffix.h"
302 
303 #endif
304 
305 
OgreHeaderSuffix.h
Ogre::SubMesh::mBoneAssignments
VertexBoneAssignmentList mBoneAssignments
Definition: OgreSubMesh.h:277
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:58
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::SubMesh::IndexMap
vector< unsigned short >::type IndexMap
Dedicated index map for translate blend index to bone index (only valid if useSharedVertices = false)...
Definition: OgreSubMesh.h:110
Ogre::ushort
unsigned short ushort
Definition: OgrePrerequisites.h:113
Ogre::SubMesh::mBuildEdgesEnabled
bool mBuildEdgesEnabled
Is Build Edges Enabled.
Definition: OgreSubMesh.h:289
Ogre::VertexAnimationType
VertexAnimationType
Type of vertex animation.
Definition: OgreAnimationTrack.h:467
Ogre::MeshSerializerImpl_v1_1
Class for providing backwards-compatibility for loading version 1.1 of the .mesh format.
Definition: OgreMeshSerializerImpl.h:259
Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME
static String AUTODETECT_RESOURCE_GROUP_NAME
Special resource group name which causes resource group to be automatically determined based on searc...
Definition: OgreResourceGroupManager.h:270
Ogre::SubMesh::indexData
IndexData * indexData
Face index data.
Definition: OgreSubMesh.h:89
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::SubMesh::operationType
RenderOperation::OperationType operationType
The render operation type used to render this submesh.
Definition: OgreSubMesh.h:77
Ogre::VertexBoneAssignment_s
Records the assignment of a single vertex to a single bone with the corresponding weight.
Definition: OgreVertexBoneAssignment.h:50
OgreResourceGroupManager.h
OgreMaterial.h
Ogre::SubMesh::mVertexAnimationType
VertexAnimationType mVertexAnimationType
Type of vertex animation for dedicated vertex data (populated by Mesh)
Definition: OgreSubMesh.h:283
Ogre::SubMesh::mTextureAliases
AliasTextureNamePairList mTextureAliases
paired list of texture aliases and texture names
Definition: OgreSubMesh.h:275
Ogre::VertexData
Summary class collecting together vertex source information.
Definition: OgreVertexIndexData.h:49
Ogre::SubMesh::useSharedVertices
bool useSharedVertices
Indicates if this submesh shares vertex data with other meshes or whether it has it's own vertices.
Definition: OgreSubMesh.h:74
OgreRenderOperation.h
OgreHeaderPrefix.h
Ogre::SubMesh::LODFaceList
vector< IndexData * >::type LODFaceList
Definition: OgreSubMesh.h:113
Ogre::SubMesh::blendIndexToBoneIndexMap
IndexMap blendIndexToBoneIndexMap
Definition: OgreSubMesh.h:111
OgrePrerequisites.h
Ogre::SubMesh
Defines a part of a complete mesh.
Definition: OgreSubMesh.h:62
Ogre::SubMesh::VertexBoneAssignmentList
multimap< size_t, VertexBoneAssignment >::type VertexBoneAssignmentList
Multimap of verex bone assignments (orders by vertex index)
Definition: OgreSubMesh.h:178
Ogre::AliasTextureNamePairList
map< String, String >::type AliasTextureNamePairList
Alias / Texture name pair (first = alias, second = texture name)
Definition: OgreCommon.h:553
Ogre::SubMesh::mLodFaceList
LODFaceList mLodFaceList
Definition: OgreSubMesh.h:114
OgreAnimationTrack.h
Ogre::multimap
Definition: OgrePrerequisites.h:547
Ogre::MapIterator
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
Definition: OgreIteratorWrapper.h:319
Ogre::SubMesh::mVertexAnimationIncludesNormals
bool mVertexAnimationIncludesNormals
Whether normals are included in vertex animation keyframes.
Definition: OgreSubMesh.h:286
Ogre::SubMesh::BoneAssignmentIterator
MapIterator< VertexBoneAssignmentList > BoneAssignmentIterator
Definition: OgreSubMesh.h:179
OgreVertexIndexData.h
Ogre::SubMesh::parent
Mesh * parent
Reference to parent Mesh (not a smart pointer so child does not keep parent alive).
Definition: OgreSubMesh.h:138
Ogre::SubMesh::isBuildEdgesEnabled
bool isBuildEdgesEnabled(void) const
Returns true(by default) if the submesh should be included in the mesh EdgeList, otherwise returns fa...
Definition: OgreSubMesh.h:255
Ogre::Mesh
Resource holding data about 3D mesh.
Definition: OgreMesh.h:93
Ogre::ConstMapIterator
Concrete IteratorWrapper for const access to the underlying key-value container.
Definition: OgreIteratorWrapper.h:352
Ogre::SubMesh::hasTextureAliases
bool hasTextureAliases(void) const
returns true if the sub mesh has texture aliases
Definition: OgreSubMesh.h:222
Ogre::SubMesh::getVertexAnimationIncludesNormals
bool getVertexAnimationIncludesNormals() const
Returns whether animation on dedicated vertex data includes normals.
Definition: OgreSubMesh.h:244
Ogre::RenderOperation::OperationType
OperationType
The rendering operation type to perform.
Definition: OgreRenderOperation.h:48
Ogre::SubMesh::mMatInitialised
bool mMatInitialised
Is there a material yet?
Definition: OgreSubMesh.h:272
Ogre::SubMesh::getTextureAliasCount
size_t getTextureAliasCount(void) const
Gets the number of texture aliases assigned to the sub mesh.
Definition: OgreSubMesh.h:225
Ogre::MeshSerializerImpl
Internal implementation of Mesh reading / writing for the latest version of the .mesh format.
Definition: OgreMeshSerializerImpl.h:61
Ogre::SubMesh::getBoneAssignments
const VertexBoneAssignmentList & getBoneAssignments()
Gets a const reference to the list of bone assignments.
Definition: OgreSubMesh.h:189
Ogre::vector
Definition: OgrePrerequisites.h:491
Ogre::SubMesh::mBoneAssignmentsOutOfDate
bool mBoneAssignmentsOutOfDate
Flag indicating that bone assignments need to be recompiled.
Definition: OgreSubMesh.h:280
OgreVertexBoneAssignment.h
Ogre::IndexData
Summary class collecting together index data source information.
Definition: OgreVertexIndexData.h:242
Ogre::RenderOperation
'New' rendering operation using vertex buffers.
Definition: OgreRenderOperation.h:45
Ogre::SubMesh::vertexData
VertexData * vertexData
Dedicated vertex data (only valid if useSharedVertices = false).
Definition: OgreSubMesh.h:86
Ogre::SubMesh::AliasTextureIterator
ConstMapIterator< AliasTextureNamePairList > AliasTextureIterator
Definition: OgreSubMesh.h:195
Ogre::SubMesh::extremityPoints
vector< Vector3 >::type extremityPoints
A list of extreme points on the submesh (optional).
Definition: OgreSubMesh.h:135
Ogre::SubMesh::mMaterialName
String mMaterialName
Name of the material this SubMesh uses.
Definition: OgreSubMesh.h:269
Ogre::MeshSerializerImpl_v1_2
Class for providing backwards-compatibility for loading version 1.2 of the .mesh format.
Definition: OgreMeshSerializerImpl.h:238

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Apr 13 2021 08:53:15