OgreParticleSystemManager.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 __ParticleSystemManager_H__
#define __ParticleSystemManager_H__


#include "OgrePrerequisites.h"
#include "OgreParticleSystem.h"
#include "OgreFrameListener.h"
#include "OgreSingleton.h"
#include "OgreIteratorWrappers.h"
#include "OgreScriptLoader.h"
#include "OgreResourceGroupManager.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {

    // Forward decl
    class ParticleSystemFactory;
    
    class _OgreExport ParticleSystemManager: 
        public Singleton<ParticleSystemManager>, public ScriptLoader, public FXAlloc
    {
        friend class ParticleSystemFactory;
    public:
        typedef map<String, ParticleSystem*>::type ParticleTemplateMap;
        typedef map<String, ParticleAffectorFactory*>::type ParticleAffectorFactoryMap;
        typedef map<String, ParticleEmitterFactory*>::type ParticleEmitterFactoryMap;
        typedef map<String, ParticleSystemRendererFactory*>::type ParticleSystemRendererFactoryMap;
    protected:
        OGRE_AUTO_MUTEX;
            
        ParticleTemplateMap mSystemTemplates;
        
        ParticleEmitterFactoryMap mEmitterFactories;

        ParticleAffectorFactoryMap mAffectorFactories;

        ParticleSystemRendererFactoryMap mRendererFactories;

        StringVector mScriptPatterns;

        // Factory instance
        ParticleSystemFactory* mFactory;

        void parseNewEmitter(const String& type, DataStreamPtr& chunk, ParticleSystem* sys);
        void parseNewAffector(const String& type, DataStreamPtr& chunk, ParticleSystem* sys);
        void parseAttrib(const String& line, ParticleSystem* sys);
        void parseEmitterAttrib(const String& line, ParticleEmitter* sys);
        void parseAffectorAttrib(const String& line, ParticleAffector* sys);
        void skipToNextCloseBrace(DataStreamPtr& chunk);
        void skipToNextOpenBrace(DataStreamPtr& chunk);

        ParticleSystem* createSystemImpl(const String& name, size_t quota, 
            const String& resourceGroup);
        ParticleSystem* createSystemImpl(const String& name, const String& templateName);
        void destroySystemImpl(ParticleSystem* sys);
        
        
    public:

        ParticleSystemManager();
        virtual ~ParticleSystemManager();

        void addEmitterFactory(ParticleEmitterFactory* factory);

        void addAffectorFactory(ParticleAffectorFactory* factory);

        void addRendererFactory(ParticleSystemRendererFactory* factory);

        void addTemplate(const String& name, ParticleSystem* sysTemplate);

        void removeTemplate(const String& name, bool deleteTemplate = true);

        void removeAllTemplates(bool deleteTemplate = true);


        void removeTemplatesByResourceGroup(const String& resourceGroup);

        ParticleSystem* createTemplate(const String& name, const String& resourceGroup);

        ParticleSystem* getTemplate(const String& name);

        ParticleEmitter* _createEmitter(const String& emitterType, ParticleSystem* psys);

        void _destroyEmitter(ParticleEmitter* emitter);

        ParticleAffector* _createAffector(const String& affectorType, ParticleSystem* psys);

        void _destroyAffector(ParticleAffector* affector);

        ParticleSystemRenderer* _createRenderer(const String& rendererType);

        void _destroyRenderer(ParticleSystemRenderer* renderer);

        void _initialise(void);

        const StringVector& getScriptPatterns(void) const;
        void parseScript(DataStreamPtr& stream, const String& groupName);
        Real getLoadingOrder(void) const;

        typedef MapIterator<ParticleAffectorFactoryMap> ParticleAffectorFactoryIterator;
        typedef MapIterator<ParticleEmitterFactoryMap> ParticleEmitterFactoryIterator;
        typedef MapIterator<ParticleSystemRendererFactoryMap> ParticleRendererFactoryIterator;
        ParticleAffectorFactoryIterator getAffectorFactoryIterator(void);
        ParticleEmitterFactoryIterator getEmitterFactoryIterator(void);
        ParticleRendererFactoryIterator getRendererFactoryIterator(void);


        typedef MapIterator<ParticleTemplateMap> ParticleSystemTemplateIterator;
        ParticleSystemTemplateIterator getTemplateIterator(void)
        {
            return ParticleSystemTemplateIterator(
                mSystemTemplates.begin(), mSystemTemplates.end());
        } 

        ParticleSystemFactory* _getFactory(void) { return mFactory; }
        
        static ParticleSystemManager& getSingleton(void);
        static ParticleSystemManager* getSingletonPtr(void);

    };

    class _OgreExport ParticleSystemFactory : public MovableObjectFactory
    {
    protected:
        MovableObject* createInstanceImpl(const String& name, const NameValuePairList* params);
    public:
        ParticleSystemFactory() {}
        ~ParticleSystemFactory() {}
        
        static String FACTORY_TYPE_NAME;

        const String& getType(void) const;
        void destroyInstance( MovableObject* obj);  

    };
}

#include "OgreHeaderSuffix.h"

#endif