Ogre::Plugin Class Reference

Class defining a generic OGRE plugin. More...

#include <OgrePlugin.h>

Inheritance diagram for Ogre::Plugin:

Public Member Functions
	Plugin ()
virtual	~Plugin ()
virtual void	getAbiCookie (AbiCookie &outAbiCookie)=0
	Outputs an ABI cookie generated by generateAbiCookie. More...
virtual const String &	getName () const =0
	Get the name of the plugin. More...
virtual void	initialise ()=0
	Perform any tasks the plugin needs to perform on full system initialisation. More...
virtual void	install (const NameValuePairList *options)=0
	Perform the plugin initial installation sequence. More...
virtual void	shutdown ()=0
	Perform any tasks the plugin needs to perform when the system is shut down. More...
virtual void	uninstall ()=0
	Perform the final plugin uninstallation sequence. More...

Detailed Description

Class defining a generic OGRE plugin.

Remarks

OGRE is very plugin-oriented and you can customise much of its behaviour by registering new plugins, dynamically if you are using dynamic linking. This class abstracts the generic interface that all plugins must support. Within the implementations of this interface, the plugin must call other OGRE classes in order to register the detailed customisations it is providing, e.g. registering a new SceneManagerFactory, a new MovableObjectFactory, or a new RenderSystem.

Plugins can be linked statically or dynamically. If they are linked dynamically (ie the plugin is in a DLL or Shared Object file), then you load the plugin by calling the Root::loadPlugin method (or some other mechanism which leads to that call, e.g. plugins.cfg), passing the name of the DLL. OGRE will then call a global init function on that DLL, and it will be expected to register one or more Plugin implementations using Root::installPlugin. The procedure is very similar if you use a static linked plugin, except that you simply instantiate the Plugin implementation yourself and pass it to Root::installPlugin.

Note

Lifecycle of a Plugin instance is very important. The Plugin instance must remain valid until the Plugin is uninstalled. Here are the things you must bear in mind:

• If your plugin is in a DLL:
  • Create the Plugin instance and call Root::installPlugin in dllStartPlugin
  • Call Root::uninstallPlugin, then delete it in dllStopPlugin
• If your plugin is statically linked in your app:
  • Create the Plugin anytime you like
  • Call Root::installPlugin any time whilst Root is valid
  • Call Root::uninstallPlugin if you like so long as Root is valid. However, it will be done for you when Root is destroyed, so the Plugin instance must still be valid at that point if you haven't manually uninstalled it.

The install and uninstall methods will be called when the plugin is installed or uninstalled. The initialise and shutdown will be called when there is a system initialisation or shutdown, e.g. when Root::initialise or Root::shutdown are called.

Constructor & Destructor Documentation

Plugin()

Ogre::Plugin::Plugin ( )

inline

~Plugin()

virtual Ogre::Plugin::~Plugin ( )

inlinevirtual

Member Function Documentation

getAbiCookie()

virtual void Ogre::Plugin::getAbiCookie ( AbiCookie &  outAbiCookie )

pure virtual

Outputs an ABI cookie generated by generateAbiCookie.

Implemented in Ogre::VulkanPlugin, Ogre::NULLPlugin, Ogre::MetalPlugin, Ogre::GL3PlusPlugin, Ogre::D3D11Plugin, Ogre::ParticleFX2Plugin, and Ogre::ParticleFXPlugin.

getName()

virtual const String& Ogre::Plugin::getName ( ) const

pure virtual

Get the name of the plugin.

Remarks

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

Implemented in Ogre::VulkanPlugin, Ogre::NULLPlugin, Ogre::MetalPlugin, Ogre::GL3PlusPlugin, Ogre::D3D11Plugin, Ogre::ParticleFX2Plugin, Ogre::ParticleFXPlugin, and Ogre::GLES2Plugin.

initialise()

virtual void Ogre::Plugin::initialise ( )

pure 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.

Implemented in Ogre::VulkanPlugin, Ogre::NULLPlugin, Ogre::MetalPlugin, Ogre::GL3PlusPlugin, Ogre::D3D11Plugin, Ogre::ParticleFX2Plugin, Ogre::ParticleFXPlugin, and Ogre::GLES2Plugin.

install()

virtual void Ogre::Plugin::install ( const NameValuePairList *  options )

pure 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().

Implemented in Ogre::VulkanPlugin, Ogre::NULLPlugin, Ogre::MetalPlugin, Ogre::GL3PlusPlugin, Ogre::D3D11Plugin, Ogre::ParticleFX2Plugin, and Ogre::ParticleFXPlugin.

shutdown()

virtual void Ogre::Plugin::shutdown ( )

pure 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.

Implemented in Ogre::VulkanPlugin, Ogre::NULLPlugin, Ogre::MetalPlugin, Ogre::GL3PlusPlugin, Ogre::D3D11Plugin, Ogre::ParticleFX2Plugin, Ogre::ParticleFXPlugin, and Ogre::GLES2Plugin.

uninstall()

virtual void Ogre::Plugin::uninstall ( )

pure 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.

Implemented in Ogre::VulkanPlugin, Ogre::NULLPlugin, Ogre::MetalPlugin, Ogre::GL3PlusPlugin, Ogre::D3D11Plugin, Ogre::ParticleFX2Plugin, Ogre::ParticleFXPlugin, and Ogre::GLES2Plugin.

---

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

• OgrePlugin.h