Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IRmGeneratorPlugIn Class Reference

Generator plugin. More...

#include <RmPlugIn.h>

Inheritance diagram for IRmGeneratorPlugIn:

IRmPlugIn List of all members.

Public Member Functions

virtual bool GenerateData (RmNode *pNode, bool bSilentGenerate=false)=0

Detailed Description

Generator plugin.

A plug-in implementing this interface is used by the main application to generate new contents for the specified node. The plug-in has complete control about the contents that it will create but it must maintain validity of node rules for the main database. RM_PLUGINTYPE_GENERATOR in its plug-in description structure.


Member Function Documentation

virtual bool IRmGeneratorPlugIn::GenerateData RmNode pNode,
bool  bSilentGenerate = false
[pure virtual]
 

Generate contents for the specified input node. Using method is the main path for generating new contents for a node (especially if the plug-in uses UI widgets for parameter input. If 'bSilentGenerate' is true that means that thsi is a silent call to generate data (i.e. the plug-in shouldn't bring up any UI) that gets called when the workspace is updated or when the workspace is loaded into the application. The assumption is that the input node already has parameters necessary for content generation stored in RmPlugInData and therefore this plug-in can just quietly regenerate node contents. Implementing this method enables RenderMonkey to automatically regenerate node contents on paste operations across multiple application execution and other similar circumstances.

Parameters:
pNode Node to generate
bSilentGenerate If true, no UI will popup
Returns:
True on success


The documentation for this class was generated from the following file:
Generated on Fri Feb 25 16:08:49 2005 for RenderMonkey SDK by doxygen 1.3.6