OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreParticleFXPlugin.h
Go to the documentation of this file.
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-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __ParticleFXPlugin_H__
29 #define __ParticleFXPlugin_H__
30 
31 #include "OgrePlugin.h"
34 
35 namespace Ogre
36 {
37 
39  class ParticleFXPlugin : public Plugin
40  {
41  public:
43 
44 
46  const String& getName() const;
47 
49  void install();
50 
52  void initialise();
53 
55  void shutdown();
56 
58  void uninstall();
59  protected:
62 
63  };
64 }
65 
66 #endif
void initialise()
Perform any tasks the plugin needs to perform on full system initialisation.
std::vector< T, A > type
const String & getName() const
Get the name of the plugin.
vector< ParticleAffectorFactory * >::type mAffectorFactories
void shutdown()
Perform any tasks the plugin needs to perform when the system is shut down.
Class defining a generic OGRE plugin.
Definition: OgrePlugin.h:79
vector< ParticleEmitterFactory * >::type mEmitterFactories
void install()
Perform the plugin initial installation sequence.
_StringBase String
Plugin instance for ParticleFX Manager.
void uninstall()
Perform the final plugin uninstallation sequence.