[5] | 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-2006 Torus Knot Software Ltd |
---|
| 8 | Also see acknowledgements in Readme.html |
---|
| 9 | |
---|
| 10 | This program is free software; you can redistribute it and/or modify it under |
---|
| 11 | the terms of the GNU Lesser General Public License as published by the Free Software |
---|
| 12 | Foundation; either version 2 of the License, or (at your option) any later |
---|
| 13 | version. |
---|
| 14 | |
---|
| 15 | This program is distributed in the hope that it will be useful, but WITHOUT |
---|
| 16 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
---|
| 17 | FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. |
---|
| 18 | |
---|
| 19 | You should have received a copy of the GNU Lesser General Public License along with |
---|
| 20 | this program; if not, write to the Free Software Foundation, Inc., 59 Temple |
---|
| 21 | Place - Suite 330, Boston, MA 02111-1307, USA, or go to |
---|
| 22 | http://www.gnu.org/copyleft/lesser.txt. |
---|
| 23 | |
---|
| 24 | You may alternatively use this source under the terms of a specific version of |
---|
| 25 | the OGRE Unrestricted License provided you have obtained such a license from |
---|
| 26 | Torus Knot Software Ltd. |
---|
| 27 | ----------------------------------------------------------------------------- |
---|
| 28 | */ |
---|
| 29 | #ifndef __ParticleAffectorFactory_H__ |
---|
| 30 | #define __ParticleAffectorFactory_H__ |
---|
| 31 | |
---|
| 32 | |
---|
| 33 | #include "OgrePrerequisites.h" |
---|
| 34 | #include "OgreParticleAffector.h" |
---|
| 35 | |
---|
| 36 | namespace Ogre { |
---|
| 37 | |
---|
| 38 | /** Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses. |
---|
| 39 | @remarks |
---|
| 40 | Plugins or 3rd party applications can add new types of particle affectors to Ogre by creating |
---|
| 41 | subclasses of the ParticleAffector class. Because multiple instances of these affectors may be |
---|
| 42 | required, a factory class to manage the instances is also required. |
---|
| 43 | @par |
---|
| 44 | ParticleAffectorFactory subclasses must allow the creation and destruction of ParticleAffector |
---|
| 45 | subclasses. They must also be registered with the ParticleSystemManager. All factories have |
---|
| 46 | a name which identifies them, examples might be 'force_vector', 'attractor', or 'fader', and these can be |
---|
| 47 | also be used from particle system scripts. |
---|
| 48 | */ |
---|
| 49 | class _OgreExport ParticleAffectorFactory |
---|
| 50 | { |
---|
| 51 | protected: |
---|
| 52 | std::vector<ParticleAffector*> mAffectors; |
---|
| 53 | public: |
---|
| 54 | ParticleAffectorFactory() {}; |
---|
| 55 | virtual ~ParticleAffectorFactory(); |
---|
| 56 | /** Returns the name of the factory, the name which identifies the particle affector type this factory creates. */ |
---|
| 57 | virtual String getName() const = 0; |
---|
| 58 | |
---|
| 59 | /** Creates a new affector instance. |
---|
| 60 | @remarks |
---|
| 61 | The subclass MUST add a pointer to the created instance to mAffectors. |
---|
| 62 | */ |
---|
| 63 | virtual ParticleAffector* createAffector(ParticleSystem* psys) = 0; |
---|
| 64 | |
---|
| 65 | /** Destroys the affector pointed to by the parameter (for early clean up if reauired). */ |
---|
| 66 | virtual void destroyAffector(ParticleAffector* e); |
---|
| 67 | }; |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | } |
---|
| 71 | |
---|
| 72 | |
---|
| 73 | #endif |
---|
| 74 | |
---|