OgreSubMesh.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __SubMesh_H_
#define __SubMesh_H_

#include "OgrePrerequisites.h"

#include "OgreVertexIndexData.h"
#include "OgreMaterial.h"
#include "OgreRenderOperation.h"
#include "OgreVertexBoneAssignment.h"
#include "OgreAnimationTrack.h"
#include "OgreResourceGroupManager.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {

    class _OgreExport SubMesh : public SubMeshAlloc
    {
        friend class Mesh;
        friend class MeshSerializerImpl;
        friend class MeshSerializerImpl_v1_2;
        friend class MeshSerializerImpl_v1_1;
    public:
        SubMesh();
        ~SubMesh();


        bool useSharedVertices;

        RenderOperation::OperationType operationType;

        VertexData *vertexData;

        IndexData *indexData;

        typedef vector<unsigned short>::type IndexMap;
        IndexMap blendIndexToBoneIndexMap;

        typedef vector<IndexData*>::type LODFaceList;
        LODFaceList mLodFaceList;

        vector<Vector3>::type extremityPoints;

        Mesh* parent;

        void setMaterialName(const String& matName, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );
        const String& getMaterialName(void) const;

        bool isMatInitialised(void) const;

        void _getRenderOperation(RenderOperation& rend, ushort lodIndex = 0);

        void addBoneAssignment(const VertexBoneAssignment& vertBoneAssign);

        void clearBoneAssignments(void);

        typedef multimap<size_t, VertexBoneAssignment>::type VertexBoneAssignmentList;
        typedef MapIterator<VertexBoneAssignmentList> BoneAssignmentIterator;

        BoneAssignmentIterator getBoneAssignmentIterator(void);

        const VertexBoneAssignmentList& getBoneAssignments() { return mBoneAssignments; }


        void _compileBoneAssignments(void);

        typedef ConstMapIterator<AliasTextureNamePairList> AliasTextureIterator;
        AliasTextureIterator getAliasTextureIterator(void) const;
        void addTextureAlias(const String& aliasName, const String& textureName);
        void removeTextureAlias(const String& aliasName);
        void removeAllTextureAliases(void);
        bool hasTextureAliases(void) const { return !mTextureAliases.empty(); }
        size_t getTextureAliasCount(void) const { return mTextureAliases.size(); }

        bool updateMaterialUsingTextureAliases(void);

        VertexAnimationType getVertexAnimationType(void) const;
        
        bool getVertexAnimationIncludesNormals() const { return mVertexAnimationIncludesNormals; }


        void generateExtremes(size_t count);

        bool isBuildEdgesEnabled(void) const { return mBuildEdgesEnabled; }
        void setBuildEdgesEnabled(bool b);
        SubMesh * clone(const String& newName, Mesh *parentMesh = 0);

    protected:

        String mMaterialName;

        bool mMatInitialised;

        AliasTextureNamePairList mTextureAliases;

        VertexBoneAssignmentList mBoneAssignments;

        bool mBoneAssignmentsOutOfDate;

        mutable VertexAnimationType mVertexAnimationType;

        mutable bool mVertexAnimationIncludesNormals;

        bool mBuildEdgesEnabled;

        void removeLodLevels(void);


    };
} // namespace

#include "OgreHeaderSuffix.h"

#endif