Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

nvutil::PlugIn Class Reference

Plug-in base class. More...

#include <PlugIn.h>

Inheritance diagram for nvutil::PlugIn:

Inheritance graph
[legend]
Collaboration diagram for nvutil::PlugIn:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void setCallback (PlugInCallback *cb, bool throwExceptionOnError=true)
 Set the callback object to use on this PlugIn.

Protected Member Functions

virtual void deleteThis (void)=0
 Plug-in deletion.
const PlugInCallbackcallback (void) const
 Get the current callback object.

Friends

class PlugInServer
 Plug-in managment.

Detailed Description

Plug-in base class.

Serves as base class for all user defined plug-ins.


Member Function Documentation

void nvutil::PlugIn::setCallback PlugInCallback cb,
bool  throwExceptionOnError = true
[inline]
 

Set the callback object to use on this PlugIn.

The PlugInCallback object is used to report errors and warnings that happen while using this PlugIn.

Parameters:
cb  callback object to use
throwExceptionOnError  true if an exception is thrown on error

virtual void nvutil::PlugIn::deleteThis void   )  [protected, pure virtual]
 

Plug-in deletion.

Every plug-in must provide this function. It assures that, when deleting the plug-in object, always the right heap manager is called to free the associated memory.

Note:
Ordinary client code is not allowed to call deleteThis on a plug-in object. Client code needs to utilize the PlugInServer interface for plug-in managment for this purposes.

Implemented in NBFLoader, NVBLoader, NVSGLoader, WRLLoader, NBFSaver, and NVSGSaver.

const PlugInCallback * nvutil::PlugIn::callback void   )  const [inline, protected]
 

Get the current callback object.


Friends And Related Function Documentation

friend class PlugInServer [friend]
 

Plug-in managment.

A PlugInServer is also responsible for releasing plug-in objects after usage and therefore needs access to the private member function deleteThis.


The documentation for this class was generated from the following file:
Generated on Tue Mar 1 13:21:13 2005 for NVSGSDK by NVIDIA