IRmPlugIn Class Reference

PlugIn interface. More...

#include <RmPlugIn.h>

Inheritance diagram for IRmPlugIn:

List of all members.

Public Member Functions
virtual	~IRmPlugIn ()
	Virtual destructor.
virtual bool	Init ()=0
virtual void	Uninitialize ()=0
virtual const RmPlugInDescription &	GetPlugInDescription () const=0
virtual int	MessageHandler (int nMessageID, int nMessageData, int nMessageParameter=0, const RmPlugInID *pRmPlugInID=NULL)=0
virtual bool	HasPropertyDlg ()
virtual HWND	AddPropertyDlg (HWND hParentWnd)

---

Detailed Description

PlugIn interface.

Generic RenderMonkey plug-in interface. Designed to receive main communication messages from the main application and to specify a property page dialog for main application preferences. Must specify RM_PLUGINTYPE_GENERIC as the plug-in type value in the plug-in description.

---

Member Function Documentation

virtual HWND IRmPlugIn::AddPropertyDlg (  HWND  hParentWnd  )  [inline, virtual]

This method is used to allow the plug-in to create the actual property page dialog window attached to the specified parent window ('hParentWnd') and return a window handle to the application. Parameters: hParentWnd  Parent for creating property page Returns: Property page window handle

virtual const RmPlugInDescription& IRmPlugIn::GetPlugInDescription (   )  const [pure virtual]

Retrieve plug-in description (see declaration above) structure Returns: PlugIn description See also: RmPlugInDescription

virtual bool IRmPlugIn::HasPropertyDlg (   )  [inline, virtual]

This method notifies the main application whether this plug-in has a property page that it wishes to add to the application preferences dialog. The plug-in must handle saving of the preferences itself. If this message returns true, the plug-in will provide a property page dialog. Returns: True if plugin has property page

virtual bool IRmPlugIn::Init (   )  [pure virtual]

Initialization entry point. Used to initialize all plug-in instance specific data. This method gets invoked right after loading of the plug-in from its DLL on application start. Returns: True if initialization succeed

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

Main message handler procedure. This method gets invoked whenever the main application broadcasts a message to plug-ins. See RmDefines.h for message definitions and details. This method must return RM_OK if it successfully handled the message and RM_FAIL if any problems were encountered. Parameters: nMessageID  Message type nMessageData  Data associated with Message nMessageParameter  Paramater associated with Message pRmPlugInID  ID PlugIn of who initiated this message Returns: RM_OK if success RM_FAIL if failed

virtual void IRmPlugIn::Uninitialize (   )  [pure virtual]

Uninitialization of the plug-in. This method gets called right before the plug-in is unloaded from memory and the application exit. Returns: None

---

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

• RmPlugIn.h

---