OgreHapticsForceEffectManager.h

Go to the documentation of this file.

/*
This source file is part of OgreHaptics
 (a library for wrapping haptics devices for use with the open-source
 graphics engine OGRE, http://www.ogre3d.org)

Copyright (c) 2006 - 2008 Jorrit de Vries
Also see acknowledgements in Readme.html

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation; either version 2.1
of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
*/
// -- Template system based on Ogre::ParticleSystemManager, original copyright follows --
// 
// This source file is part of OGRE
//    (Object-oriented Graphics Rendering Engine)
// For the latest info, see http://www.ogre3d.org/
//
// Copyright (c) 2000-2006 Torus Knot Software Ltd
// Also see acknowledgements in Readme.html
//
// This program is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free Software
// Foundation; either version 2 of the License, or (at your option) any later
// version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License along with
// this program; if not, write to the Free Software Foundation, Inc., 59 Temple
// Place - Suite 330, Boston, MA 02111-1307, USA, or go to
// http://www.gnu.org/copyleft/lesser.txt.
//
// You may alternatively use this source under the terms of a specific version of
// the OGRE Unrestricted License provided you have obtained such a license from
// Torus Knot Software Ltd.
#ifndef _OgreHapticsForceEffectManager_H__
#define _OgreHapticsForceEffectManager_H__

#include "OgreHapticsPrerequisites.h"

namespace OgreHaptics {

    class _OgreHapticsExport ForceEffectManager : public Singleton<ForceEffectManager>,
        public ScriptLoader
    {
    protected:
        typedef std::map<String, ForceEffect*> ForceEffectMap;
        typedef std::map<String, ForceEffectAlgorithmFactory*> ForceEffectAlgorithmFactoryMap;
    public:
        ForceEffectManager();
        virtual ~ForceEffectManager();
        static ForceEffectManager& getSingleton(void);
        static ForceEffectManager* getSingletonPtr(void);

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

        ForceEffect* createTemplate(const String& name);
        void addTemplate(const String& name, ForceEffect* effect);
        ForceEffect* getTemplate(const String& name);

        typedef ConstMapIterator<ForceEffectMap> ForceEffectIterator;
        ForceEffectIterator getTemplateIterator(void);
        void removeTemplate(const String& name, bool deleteTemplate = true);
        void removeAllTemplates(bool deleteTemplates = true);

        ForceEffect* createEffect(const String& name, const String& templateName);
        ForceEffect* createEffect(const String& name);
        ForceEffect* getEffect(const String& name) const;
        bool hasEffect(const String& name) const;
        void destroyEffect(const String& name);
        void destroyEffect(ForceEffect* effect);
        void destroyAllEffects(void);

        void addAlgorithmFactory(ForceEffectAlgorithmFactory* factory);

        typedef ConstMapIterator<ForceEffectAlgorithmFactoryMap>
            ForceEffectAlgorithmFactoryIterator;
        ForceEffectAlgorithmFactoryIterator getAlgorithmFactoryIterator(void);

        ForceEffectAlgorithm* _createAlgorithm(const String& algorithmType);
        void _destroyAlgorithm(ForceEffectAlgorithm* algorithm);
    protected:
        OGREHAPTICS_AUTO_MUTEX
        ForceEffectMap mEffectTemplates;
        ForceEffectMap mEffects;
        ForceEffectAlgorithmFactoryMap mAlgorithmFactories;
        StringVector mScriptPatterns;

        void parseNewAlgorithm(const String& type, DataStreamPtr& stream, ForceEffect* effect);
        void parseAttrib(const String& line, ForceEffect* effect);
        void parseAlgorithmAttrib(const String& line, ForceEffectAlgorithm* algorithm);
        void skipToNextCloseBrace(DataStreamPtr& stream);
        void skipToNextOpenBrace(DataStreamPtr& stream);
    };

}

#endif

---

Last modified Tue Jan 6 22:31:25 2009