RmModuleManager Class Reference

Module Manager. More...

#include <RmPlugIn.h>

List of all members.

Public Types
typedef RmLinkedList< RmModule * >	ModuleList
typedef ModuleList::iterator	ModuleListIterator
typedef ModuleList::const_iterator	ModuleListConstIterator
Public Member Functions
virtual void	Init ()
virtual void	Uninitialize ()
virtual RmModule *	GetModule (RmNode *pNode)
virtual void	RegisterModule (RmModule *pModule)
	Register a new module with this module manager.
virtual void	UnregisterModule (RmModule *pModule)
ModuleListIterator	BeginModule ()
	Utility methods for module interation.
ModuleListConstIterator	BeginModule () const
ModuleListIterator	EndModule ()
ModuleListConstIterator	EndModule () const
ModuleListIterator	EraseModuleItr (ModuleListIterator itr)
	Delete a module iterator from the list of modules.
int	GetNumModules () const
	Retrieve the number of opened modules for this module manager.
virtual int	MessageHandler (int nMessageID, int nMessageData, int nMessageParameter=0, const RmPlugInID *pRmPlugInID=NULL)

---

Detailed Description

Module Manager.

Helper class used to manage plug-in instances (modules) for a specific plug-in. See SDK documentation for more details.

---

Member Function Documentation

virtual RmModule* RmModuleManager::GetModule (  RmNode *  pNode  )  [virtual]

This function searches in already opened module list and if it finds any module that is associated with the specified node ('pNode'), returns it. The method returns NULL if no associated modules were found.

virtual void RmModuleManager::Init (   )  [virtual]

This method gets invoked during plug-in library initialization method right upon the startup of the main application.

virtual int RmModuleManager::MessageHandler (  int  nMessageID, int  nMessageData, int  nMessageParameter = 0, const RmPlugInID *  pRmPlugInID = NULL )  [virtual]

An entry point for handling RenderMonkey specific messages (see comments for // IRmPlugIn::MessageHandler above. The method must return RM_OK if it successfully handles // the application message or RM_FAIL if any errors were encountered during processing //

virtual void RmModuleManager::Uninitialize (   )  [virtual]

This method gets invoked during plug-in library un-initialization prior to the shutdown of the main application.

virtual void RmModuleManager::UnregisterModule (  RmModule *  pModule  )  [virtual]

Unregisters specified module from this module manager. Note that this method does not call a destructor on the actual module, but simply removes it from the module manager list of modules.

---

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

• RmPlugIn.h

---