IvtPluginsManager Class Reference

Class that manages the loading of IvTune plug-ins. More...

#include <IvTune/IvTuneExtender/IvtPluginsManager.h>

Inheritance diagram for IvtPluginsManager:

Public Member Functions
void	addProfile (IvtProfile *profile)
	Add the specified profile to the list of profiles managed by this plug-in manager.
IvtProfile *	getActiveProfile () const
	Returns the active profile.
IvtPlugin *	getPluginByName (const SbString &name)
	Returns a plug-in given its name.
const std::list< IvtPlugin * > &	getPlugins () const
	Returns the loaded plug-ins list.
IvtProfile *	getProfileByName (const SbString &name)
	Returns a profile given its name.
const std::list< IvtProfile * > &	getProfilesList () const
	Returns the profiles list.
IvtPlugin *	loadPlugin (const SbString &path, const SbString &fileName)
	Load the specified plug-in and return a pointer to it.
void	read (const SbString &configFilePath, bool isPath=true)
	Read the configuration file, load plug-ins and extensions, and set up the profiles.
void	removeProfile (IvtProfile *profile)
	Remove the given profile from the list of managed profiles.
void	setActiveProfile (IvtProfile *profile)
	Set the given profile to be the active profile.
void	unloadPlugin (IvtPlugin *plugin)
	Unload the specified plug-in.
void	unloadAllPlugins ()
	Unload all the loaded plug-ins.
void	write (const SbString &configFilePath)
	Write the current configuration to the specified file.
	~IvtPluginsManager ()
	Destructor.

Static Public Member Functions
static IvtPluginsManager *	getInstance ()
	Returns an instance of this plug-ins manager.
static void	releaseInstance ()
	Release the current instance of this plug-ins manager.

Detailed Description

Class that manages the loading of IvTune plug-ins.

This class automatically loads the IvTune plug-ins and their extensions according to the profile configuration.

Since Open Inventor 9.0

SEE ALSO

IvtProfile

Definition at line 72 of file IvtPluginsManager.h.

Constructor & Destructor Documentation

~IvtPluginsManager()

IvtPluginsManager::~IvtPluginsManager

(

)

Destructor.

Member Function Documentation

addProfile()

void IvtPluginsManager::addProfile

(

IvtProfile *

profile

)

Add the specified profile to the list of profiles managed by this plug-in manager.

Parameters

profile

the profile to add.

getActiveProfile()

IvtProfile * IvtPluginsManager::getActiveProfile

(

)

const

Returns the active profile.

getInstance()

static IvtPluginsManager * IvtPluginsManager::getInstance ( )

static

Returns an instance of this plug-ins manager.

getPluginByName()

IvtPlugin * IvtPluginsManager::getPluginByName

(

const SbString &

name

)

Returns a plug-in given its name.

Parameters

name	the name of the plug-in to get.

getPlugins()

const std::list< IvtPlugin * > & IvtPluginsManager::getPlugins

(

)

const

Returns the loaded plug-ins list.

getProfileByName()

IvtProfile * IvtPluginsManager::getProfileByName

(

const SbString &

name

)

Returns a profile given its name.

Parameters

name	the name of the profile to get.

getProfilesList()

const std::list< IvtProfile * > & IvtPluginsManager::getProfilesList

(

)

const

Returns the profiles list.

loadPlugin()

IvtPlugin * IvtPluginsManager::loadPlugin	(	const SbString &	path,
		const SbString &	fileName
	)

Load the specified plug-in and return a pointer to it.

Parameters

path	the path to the plug-in to load.
fileName	the name of the plug-in to load.

read()

void IvtPluginsManager::read	(	const SbString &	configFilePath,
		bool	isPath = true
	)

Read the configuration file, load plug-ins and extensions, and set up the profiles.

Parameters

configFilePath	the path to the configuration file to load.
isPath	indicates whether it is a path to file or an in-memory file.

releaseInstance()

static void IvtPluginsManager::releaseInstance ( )

static

Release the current instance of this plug-ins manager.

All Plug-ins and extensions are unloaded before.

removeProfile()

void IvtPluginsManager::removeProfile

(

IvtProfile *

profile

)

Remove the given profile from the list of managed profiles.

Parameters

profile

the profile to remove.

setActiveProfile()

void IvtPluginsManager::setActiveProfile

(

IvtProfile *

profile

)

Set the given profile to be the active profile.

Extensions in the previous profile are deactivated and extensions in the given profile are activated.

Parameters

profile

the new active profile.

unloadAllPlugins()

void IvtPluginsManager::unloadAllPlugins

(

)

Unload all the loaded plug-ins.

unloadPlugin()

void IvtPluginsManager::unloadPlugin

(

IvtPlugin *

plugin

)

Unload the specified plug-in.

Parameters

plugin

the plugin to unload.

write()

void IvtPluginsManager::write

(

const SbString &

configFilePath

)

Write the current configuration to the specified file.

Parameters

configFilePath

the path to the configuration file.

---

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

• IvTune/IvTuneExtender/IvtPluginsManager.h