LightWrap++
AC++wrapperfortheLightWave3DSDK
lwpp::InstanceHandler Class Reference

Base class for (almost) any LW plugin. More...

#include <plugin_handler.h>

+ Inheritance diagram for lwpp::InstanceHandler:
+ Collaboration diagram for lwpp::InstanceHandler:

List of all members.

Public Member Functions

 InstanceHandler (void *priv, void *context, LWError *err, const char *_className)
virtual ~InstanceHandler ()
virtual const char * DescLn ()
virtual LWError Load (const LoadState &ls)
 Load data from a LWLoadState.
virtual LWError Save (const SaveState &ss)
 Save data to a LWSaveState.
void SetClassName (const char *n)
void SetDescription (const char *n)
void SetDescription (const std::string &s)
void SetName (const char *n)
void Update ()
void Update (const char *cName)

Protected Attributes

const char * m_className
std::string m_description
const char * m_pluginName
InstanceUpdate m_update

Detailed Description

Base class for (almost) any LW plugin.


Constructor & Destructor Documentation

lwpp::InstanceHandler::InstanceHandler ( void *  priv,
void *  context,
LWError *  err,
const char *  _className 
)
inline
virtual lwpp::InstanceHandler::~InstanceHandler ( )
inlinevirtual

Member Function Documentation

virtual const char* lwpp::InstanceHandler::DescLn ( )
inlinevirtual
virtual LWError lwpp::Storeable::Load ( const LoadState ls)
inlinevirtualinherited

Load data from a LWLoadState.

Parameters:
*lsLWLoadState to load from
Returns:
An error string if an error occured, 0 otherwise

Reimplemented in lwpp::LWItem, lwpp::FileName, lwpp::Image, lwpp::ColourManager, lwpp::NodeEditor, and lwpp::VParm.

virtual LWError lwpp::Storeable::Save ( const SaveState ss)
inlinevirtualinherited

Save data to a LWSaveState.

Parameters:
*ssLWSaveState to save to
Returns:
An error string if an error occured, 0 otherwise

Reimplemented in lwpp::LWItem, lwpp::FileName, lwpp::Image, lwpp::ColourManager, lwpp::NodeEditor, and lwpp::VParm.

void lwpp::InstanceHandler::SetClassName ( const char *  n)
inline
void lwpp::InstanceHandler::SetDescription ( const char *  n)
inline
void lwpp::InstanceHandler::SetDescription ( const std::string &  s)
inline
void lwpp::InstanceHandler::SetName ( const char *  n)
inline
void lwpp::InstanceHandler::Update ( )
inline
void lwpp::InstanceHandler::Update ( const char *  cName)
inline

Member Data Documentation

const char* lwpp::InstanceHandler::m_className
protected
std::string lwpp::InstanceHandler::m_description
protected
const char* lwpp::InstanceHandler::m_pluginName
protected
InstanceUpdate lwpp::InstanceHandler::m_update
protected

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