OgreInstanceManager.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 __InstanceManager_H__
#define __InstanceManager_H__

#include "OgrePrerequisites.h"
#include "OgreMesh.h"
#include "OgreRenderOperation.h"
#include "OgreHeaderPrefix.h"

namespace Ogre
{
    class _OgreExport InstanceManager : public FactoryAlloc
    {
    public:
        enum InstancingTechnique
        {
            ShaderBased,            
            TextureVTF,             
            HWInstancingBasic,      
            HWInstancingVTF,        
            InstancingTechniquesCount
        };

        enum BatchSettingId
        {
            CAST_SHADOWS        = 0,
            SHOW_BOUNDINGBOX,

            NUM_SETTINGS
        };

    private:
        struct BatchSettings
        {
            //These are all per material
            bool setting[NUM_SETTINGS];

            BatchSettings()
            {
                setting[CAST_SHADOWS]     = true;
                setting[SHOW_BOUNDINGBOX] = false;
            }
        };

        typedef vector<InstanceBatch*>::type        InstanceBatchVec;   //vec[batchN] = Batch
        typedef map<String, InstanceBatchVec>::type InstanceBatchMap;   //map[materialName] = Vec

        typedef map<String, BatchSettings>::type    BatchSettingsMap;

        const String            mName;                  //Not the name of the mesh
        MeshPtr                 mMeshReference;
        InstanceBatchMap        mInstanceBatches;
        size_t                  mIdCount;

        InstanceBatchVec        mDirtyBatches;

        RenderOperation         mSharedRenderOperation;

        size_t                  mInstancesPerBatch;
        InstancingTechnique     mInstancingTechnique;
        uint16                  mInstancingFlags;       
        unsigned short          mSubMeshIdx;
        
        BatchSettingsMap        mBatchSettings;
        SceneManager*           mSceneManager;

        size_t                  mMaxLookupTableInstances;
        unsigned char           mNumCustomParams;       //Number of custom params per instance.

        inline InstanceBatch* getFreeBatch( const String &materialName );

        InstanceBatch* buildNewBatch( const String &materialName, bool firstTime );

        void defragmentBatches( bool optimizeCull, vector<InstancedEntity*>::type &entities,
                                vector<Ogre::Vector4>::type &usedParams,
                                InstanceBatchVec &fragmentedBatches );

        void applySettingToBatches( BatchSettingId id, bool value, const InstanceBatchVec &container );

        void unshareVertices(const Ogre::MeshPtr &mesh);

    public:
        InstanceManager( const String &customName, SceneManager *sceneManager,
                         const String &meshName, const String &groupName,
                         InstancingTechnique instancingTechnique, uint16 instancingFlags,
                         size_t instancesPerBatch, unsigned short subMeshIdx, bool useBoneMatrixLookup = false);
        virtual ~InstanceManager();

        const String& getName() const { return mName; }

        SceneManager* getSceneManager() const { return mSceneManager; }

        void setInstancesPerBatch( size_t instancesPerBatch );

        void setMaxLookupTableInstances( size_t maxLookupTableInstances );

        void setNumCustomParams( unsigned char numCustomParams );

        unsigned char getNumCustomParams() const
        { return mNumCustomParams; }

        InstancingTechnique getInstancingTechnique() const
        { return mInstancingTechnique; }

        size_t getMaxOrBestNumInstancesPerBatch( String materialName, size_t suggestedSize, uint16 flags );

        InstancedEntity* createInstancedEntity( const String &materialName );

        void cleanupEmptyBatches(void);

        void defragmentBatches( bool optimizeCulling );

        void setSetting( BatchSettingId id, bool enabled, const String &materialName = StringUtil::BLANK );

        bool getSetting( BatchSettingId id, const String &materialName ) const;

        bool hasSettings( const String &materialName ) const
        { return mBatchSettings.find( materialName ) != mBatchSettings.end(); }

        void setBatchesAsStaticAndUpdate( bool bStatic );

        void _addDirtyBatch( InstanceBatch *dirtyBatch );

        void _updateDirtyBatches(void);

        typedef ConstMapIterator<InstanceBatchMap> InstanceBatchMapIterator;
        typedef ConstVectorIterator<InstanceBatchVec> InstanceBatchIterator;

        InstanceBatchMapIterator getInstanceBatchMapIterator(void) const
        { return InstanceBatchMapIterator( mInstanceBatches.begin(), mInstanceBatches.end() ); }

        InstanceBatchIterator getInstanceBatchIterator( const String &materialName ) const
        {
            InstanceBatchMap::const_iterator it = mInstanceBatches.find( materialName );
            if(it != mInstanceBatches.end())
                return InstanceBatchIterator( it->second.begin(), it->second.end() );
            else
                OGRE_EXCEPT(Exception::ERR_INVALID_STATE, "Cannot create instance batch iterator. "
                            "Material " + materialName + " cannot be found.", "InstanceManager::getInstanceBatchIterator");
        }
    };
} // namespace Ogre

#include "OgreHeaderSuffix.h"

#endif // __InstanceManager_H__