Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/ogre_src_v1-9-0/OgreMain/include/OgreParticleAffectorFactory.h @ 148

Last change on this file since 148 was 148, checked in by patricwi, 6 years ago

Added new dependencies for ogre1.9 and cegui0.8

File size: 3.2 KB
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-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef __ParticleAffectorFactory_H__
29#define __ParticleAffectorFactory_H__
30
31
32#include "OgrePrerequisites.h"
33#include "OgreParticleAffector.h"
34#include "OgreHeaderPrefix.h"
35
36namespace Ogre {
37
38        /** \addtogroup Core
39        *  @{
40        */
41        /** \addtogroup Effects
42        *  @{
43        */
44        /** Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses.
45    @remarks
46        Plugins or 3rd party applications can add new types of particle affectors to Ogre by creating
47        subclasses of the ParticleAffector class. Because multiple instances of these affectors may be
48        required, a factory class to manage the instances is also required.
49    @par
50        ParticleAffectorFactory subclasses must allow the creation and destruction of ParticleAffector
51        subclasses. They must also be registered with the ParticleSystemManager. All factories have
52        a name which identifies them, examples might be 'force_vector', 'attractor', or 'fader', and these can be
53        also be used from particle system scripts.
54    */
55        class _OgreExport ParticleAffectorFactory : public FXAlloc
56    {
57    protected:
58        vector<ParticleAffector*>::type mAffectors;
59    public:
60        ParticleAffectorFactory() {}
61        virtual ~ParticleAffectorFactory();
62        /** Returns the name of the factory, the name which identifies the particle affector type this factory creates. */
63        virtual String getName() const = 0;
64
65        /** Creates a new affector instance.
66        @remarks
67            The subclass MUST add a pointer to the created instance to mAffectors.
68        */
69        virtual ParticleAffector* createAffector(ParticleSystem* psys) = 0;
70
71        /** Destroys the affector pointed to by the parameter (for early clean up if required). */
72        virtual void destroyAffector(ParticleAffector* e);
73    };
74
75        /** @} */
76        /** @} */
77
78}
79
80#include "OgreHeaderSuffix.h"
81
82#endif
83
Note: See TracBrowser for help on using the repository browser.