source: OGRE/trunk/ogrenew/OgreMain/include/OgreParticleAffectorFactory.h @ 692

Revision 692, 2.9 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies

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