Ogre::ParticleFXPlugin Class Reference

Plugin instance for ParticleFX Manager. More...

#include <OgreParticleFXPlugin.h>

Inheritance diagram for Ogre::ParticleFXPlugin:

Public Member Functions
	ParticleFXPlugin ()
const String &	getName () const
	Get the name of the plugin. More...
void	initialise ()
	Perform any tasks the plugin needs to perform on full system initialisation. More...
void	install ()
	Perform the plugin initial installation sequence. More...
void	shutdown ()
	Perform any tasks the plugin needs to perform when the system is shut down. More...
void	uninstall ()
	Perform the final plugin uninstallation sequence. More...
Public Member Functions inherited from Ogre::Plugin
	Plugin ()
virtual	~Plugin ()

Detailed Description

Plugin instance for ParticleFX Manager.

Constructor & Destructor Documentation

ParticleFXPlugin()

Ogre::ParticleFXPlugin::ParticleFXPlugin

(

)

Member Function Documentation

getName()

const String& Ogre::ParticleFXPlugin::getName ( ) const

virtual

Get the name of the plugin.

Remarks

An implementation must be supplied for this method to uniquely identify the plugin.

Implements Ogre::Plugin.

install()

void Ogre::ParticleFXPlugin::install ( )

virtual

Perform the plugin initial installation sequence.

Remarks

An implementation must be supplied for this method. It must perform the startup tasks necessary to install any rendersystem customisations or anything else that is not dependent on system initialisation, ie only dependent on the core of Ogre. It must not perform any operations that would create rendersystem-specific objects at this stage, that should be done in initialise().

Implements Ogre::Plugin.

initialise()

void Ogre::ParticleFXPlugin::initialise ( )

virtual

Perform any tasks the plugin needs to perform on full system initialisation.

Remarks

An implementation must be supplied for this method. It is called just after the system is fully initialised (either after Root::initialise if a window is created then, or after the first window is created) and therefore all rendersystem functionality is available at this time. You can use this hook to create any resources which are dependent on a rendersystem or have rendersystem-specific implementations.

Implements Ogre::Plugin.

shutdown()

void Ogre::ParticleFXPlugin::shutdown ( )

virtual

Perform any tasks the plugin needs to perform when the system is shut down.

Remarks

An implementation must be supplied for this method. This method is called just before key parts of the system are unloaded, such as rendersystems being shut down. You should use this hook to free up resources and decouple custom objects from the OGRE system, whilst all the instances of other plugins (e.g. rendersystems) still exist.

Implements Ogre::Plugin.

uninstall()

void Ogre::ParticleFXPlugin::uninstall ( )

virtual

Perform the final plugin uninstallation sequence.

Remarks

An implementation must be supplied for this method. It must perform the cleanup tasks which haven't already been performed in shutdown() (e.g. final deletion of custom instances, if you kept them around incase the system was reinitialised). At this stage you cannot be sure what other plugins are still loaded or active. It must therefore not perform any operations that would reference any rendersystem-specific objects - those should have been sorted out in the 'shutdown' method.

Implements Ogre::Plugin.

---

The documentation for this class was generated from the following file:

• OgreParticleFXPlugin.h