Caelum::CaelumPlugin Class Reference

Implement an Ogre::Plugin for Caelum. More...

#include <CaelumPlugin.h>

Inheritance diagram for Caelum::CaelumPlugin:

Public Member Functions
void	install ()
void	initialise ()
void	shutdown ()
void	uninstall ()
bool	isInstalled () const
CaelumDefaultTypeDescriptorData *	getTypeDescriptorData ()
	Get default type descriptor data for caelum components.
void	loadCaelumSystemFromScript (CaelumSystem *sys, const Ogre::String &objectName, const Ogre::String &scriptFileGroup=Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Load CaelumSystem and it's components from a script file. More...
PropScriptResourceManager *	getPropScriptResourceManager ()
CaelumScriptTranslatorManager *	getScriptTranslatorManager ()

Static Public Member Functions
static CaelumPlugin &	getSingleton (void)
	Get reference to singleton instance; or crash if N/A.
static CaelumPlugin *	getSingletonPtr (void)
	Get pointer to singleton instance; or pointer if N/A.
Static Public Member Functions inherited from Ogre::Singleton< CaelumPlugin >
static T &	getSingleton (void)
static T *	getSingletonPtr (void)

Detailed Description

Implement an Ogre::Plugin for Caelum.

Ogre plugins are usually loaded from config files and they register various stuff in ogre managers. But you can also just link to the library normally and call install functions manually.

Member Function Documentation

loadCaelumSystemFromScript()

void Caelum::CaelumPlugin::loadCaelumSystemFromScript	(	CaelumSystem *	sys,
		const Ogre::String &	objectName,
		const Ogre::String &	scriptFileGroup = Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME
	)

Load CaelumSystem and it's components from a script file.

Parameters

sys	Target CaelumSystem. This is cleared using CaelumSystem::clear before loading. If scripting data is not found then this is not modified.
objectName	Name of caelum_sky_system from *.os file.
scriptFileGroup	The group to search in (unused in Ogre 1.6)

getPropScriptResourceManager()

PropScriptResourceManager* Caelum::CaelumPlugin::getPropScriptResourceManager ( )

inline

See also

PropScriptResourceManager