RmModule Class Reference

Module for plugin. More...

#include <RmPlugIn.h>

List of all members.

Public Member Functions
	RmModule ()
	Constructor //.
virtual	~RmModule ()
	Destructor //.
void	SetTopNode (RmNode *pNode)
const RmNode *	GetTopNode () const
	Retrieve the main node associated with this module (plug-in instance).
RmNode *	GetTopNode ()
virtual void	Shutdown ()=0
virtual int	MessageHandler (int nMessageID, int nMessageData, int nMessageParameter=0, const RmPlugInID *pRmPlugInID=NULL)=0

---

Detailed Description

Module for plugin.

Data associated with an individual instance of a plug-in associated with specific node(s) at run-time.

---

Member Function Documentation

virtual int RmModule::MessageHandler (  int  nMessageID, int  nMessageData, int  nMessageParameter = 0, const RmPlugInID *  pRmPlugInID = NULL )  [pure 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

void RmModule::SetTopNode (  RmNode *  pNode  )

The node specified by 'pNode' specifies the main node being modified (eg: edited or viewed) by the module, or plug-in instance, at run-time

virtual void RmModule::Shutdown (   )  [pure virtual]

This method gets called when the main plug-in is about to be un-initialized and be unloaded from memory and thus each module needs to clean up its data

---

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

• RmPlugIn.h

---