IvtPluginsManager Class Reference
[IvTuneExtender]

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

#include <IvTune/IvTuneExtender/IvtPluginsManager.h>

List of all members.

Public Member Functions
void	addProfile (IvtProfile *profile)
IvtProfile *	getActiveProfile () const
IvtPlugin *	getPluginByName (const SbString &name)
const std::list< IvtPlugin * > &	getPlugins () const
IvtProfile *	getProfileByName (const SbString &name)
const std::list< IvtProfile * > &	getProfilesList () const
IvtPlugin *	loadPlugin (const SbString &path, const SbString &fileName)
void	read (const SbString &configFilePath, bool isPath=true)
void	removeProfile (IvtProfile *profile)
void	setActiveProfile (IvtProfile *profile)
void	unloadPlugin (IvtPlugin *plugin)
void	unloadAllPlugins ()
void	write (const SbString &configFilePath)
	~IvtPluginsManager ()
Static Public Member Functions
static IvtPluginsManager *	getInstance ()
static void	releaseInstance ()

---

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

See related examples:

MySecondExtensionExamples

---

Constructor & Destructor Documentation

IvtPluginsManager::~IvtPluginsManager

(

)

Destructor.

---

Member Function Documentation

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.

IvtProfile* IvtPluginsManager::getActiveProfile

(

)

const

Returns the active profile.

static IvtPluginsManager* IvtPluginsManager::getInstance

(

)

[static]

Returns an instance of this plug-ins manager.

IvtPlugin* IvtPluginsManager::getPluginByName

(

const SbString &

name

)

Returns a plug-in given its name.

Parameters:

name

the name of the plug-in to get.

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

(

)

const

Returns the loaded plug-ins list.

IvtProfile* IvtPluginsManager::getProfileByName

(

const SbString &

name

)

Returns a profile given its name.

Parameters:

name

the name of the profile to get.

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

(

)

const

Returns the profiles list.

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.

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.

static void IvtPluginsManager::releaseInstance

(

)

[static]

Release the current instance of this plug-ins manager.

All Plug-ins and extensions are unloaded before.

void IvtPluginsManager::removeProfile

(

IvtProfile *

profile

)

Remove the given profile from the list of managed profiles.

Parameters:

profile

the profile to remove.

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.

void IvtPluginsManager::unloadAllPlugins

(

)

Unload all the loaded plug-ins.

void IvtPluginsManager::unloadPlugin

(

IvtPlugin *

plugin

)

Unload the specified plug-in.

Parameters:

plugin

the plugin to unload.

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