lwpp::DisplacementHandler Class Reference

Base class for Displacement plugins. More...

#include <displacement_handler.h>

Inheritance diagram for lwpp::DisplacementHandler:

Collaboration diagram for lwpp::DisplacementHandler:

List of all members.

Public Member Functions
	DisplacementHandler (void *g, void *context, LWError *err)
virtual	~DisplacementHandler ()
virtual void	ChangeID (const LWItemID *id_list)
virtual void	Cleanup ()
virtual const char *	DescLn ()
virtual void	Evaluate (LWDisplacementAccess *da)
virtual unsigned int	Flags ()
virtual LWError	Init (int mode)
virtual LWError	Load (const LoadState &ls)
	Load data from a LWLoadState.
virtual LWError	NewTime (LWFrame frame, LWTime time)
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)
virtual const LWItemID *	UseItems ()

Protected Attributes
LWItem	Context
	Stores the id of the object wich the plugin is applied to.
LWFrame	currentFrame
LWTime	currentTime
lwpp::LWItemTracker	ItemTracker
const char *	m_className
std::string	m_description
const char *	m_pluginName
InstanceUpdate	m_update
int	renderMode

---

Detailed Description

Base class for Displacement plugins.

Note:

Work in progress

---

Constructor & Destructor Documentation

lwpp::DisplacementHandler::DisplacementHandler ( void *  g, void *  context, LWError *  err  )

inline

virtual lwpp::DisplacementHandler::~DisplacementHandler ( )

inlinevirtual

---

Member Function Documentation

virtual void lwpp::ItemHandler::ChangeID ( const LWItemID *  id_list )

inlinevirtualinherited

virtual void lwpp::RenderHandler::Cleanup ( )

inlinevirtualinherited

virtual const char* lwpp::InstanceHandler::DescLn ( )

inlinevirtualinherited

virtual void lwpp::DisplacementHandler::Evaluate ( LWDisplacementAccess *  da )

inlinevirtual

virtual unsigned int lwpp::DisplacementHandler::Flags ( )

inlinevirtual

virtual LWError lwpp::RenderHandler::Init ( int  mode )

inlinevirtualinherited

virtual LWError lwpp::Storeable::Load ( const LoadState &  ls )

inlinevirtualinherited

Load data from a LWLoadState.

Parameters:

*ls	LWLoadState 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::RenderHandler::NewTime ( LWFrame  frame, LWTime  time  )

inlinevirtualinherited

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

inlinevirtualinherited

Save data to a LWSaveState.

Parameters:

*ss	LWSaveState 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 )

inlineinherited

void lwpp::InstanceHandler::SetDescription ( const char *  n )

inlineinherited

void lwpp::InstanceHandler::SetDescription ( const std::string &  s )

inlineinherited

void lwpp::InstanceHandler::SetName ( const char *  n )

inlineinherited

void lwpp::InstanceHandler::Update ( )

inlineinherited

void lwpp::InstanceHandler::Update ( const char *  cName )

inlineinherited

virtual const LWItemID* lwpp::ItemHandler::UseItems ( )

inlinevirtualinherited

---

Member Data Documentation

LWItem lwpp::DisplacementHandler::Context

protected

Stores the id of the object wich the plugin is applied to.

LWFrame lwpp::RenderHandler::currentFrame

protectedinherited

LWTime lwpp::RenderHandler::currentTime

protectedinherited

lwpp::LWItemTracker lwpp::ItemHandler::ItemTracker

protectedinherited

const char* lwpp::InstanceHandler::m_className

protectedinherited

std::string lwpp::InstanceHandler::m_description

protectedinherited

const char* lwpp::InstanceHandler::m_pluginName

protectedinherited

InstanceUpdate lwpp::InstanceHandler::m_update

protectedinherited

int lwpp::RenderHandler::renderMode

protectedinherited

---

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

• displacement_handler.h