Provide callback functions for LW Items in XPanels... More...

#include <surface.h>

Inheritance diagram for lwpp::SurfaceReference< showNone >:

Collaboration diagram for lwpp::SurfaceReference< showNone >:

Public Types
typedef SurfaceSet::iterator	iterSurfaceSet
typedef std::set< LWSurface >	SurfaceSet

Public Member Functions
	SurfaceReference (LWSurfaceID _id=0)
	Constructor, default to an object and no object selected.
virtual bool	available () const
	Check if the global is available.
SurfaceSet	byName (std::string name, std::string obj) const
SurfaceSet	byName (std::string name) const
SurfaceSet	byObject (std::string name) const
int *	DataGet ()
	XPanels compatible DataGet.
void	DataSet (void *value)
	XPanels compatible DataSet.
bool	exists ()
void	first ()
LWChanGroupID	getChannelGroup () const
const char *	getColorVMap () const
double *	getDouble (const char *channel) const
LWEnvelopeID	getEnvelope (const char *channel) const
virtual LWSurfaceFuncs *	getGlobal ()
	Get the pointer to the global.
LWSurfaceID	getID () const
LWImageID	getImage (const char *channel) const
int	GetIndex ()
LWSurfaceID	GetIndexID (int idx)
	return id of item number idx
int	getInteger (const char *channel) const
NodeEditorID	getNodeEditor ()
const char *	GetSelectedName ()
LWTextureID	getTexture (const char *channel) const
const char *	name () const
bool	next ()
LWSurfaceFuncs *	operator-> ()
	Get the pointer to the global.
bool	operator< (const LWSurface &s) const
const char *	sceneObject () const
void	setColorVMap (const char *vmapName, int type)

Static Public Member Functions
static int	PopCount (void *inst)
	PopCount callback for LightWave.
static const char *	PopName (void *inst, int n)
	PopUpName name callback for LightWave.

Protected Member Functions
bool	_acquireGlobal ()
virtual size_t	popCount (void)
	Return number of items.
virtual const char *	popName (int idx)
	return name of item number idx

Protected Attributes
LWSurfaceID	id
int	index

Static Protected Attributes
static LWSurfaceFuncs *	globPtr
	Pointer to the global functions.

Detailed Description

template<bool showNone = true>
class lwpp::SurfaceReference< showNone >

Provide callback functions for LW Items in XPanels...

This class takes care of an item, including loading and saving item references

Todo:: turn this into a more universal wrapper, a managed variable/item or something like it...

Member Typedef Documentation

typedef SurfaceSet::iterator lwpp::LWSurface::iterSurfaceSet

inherited

typedef std::set<LWSurface> lwpp::LWSurface::SurfaceSet

inherited

Constructor & Destructor Documentation

template<bool showNone = true>

lwpp::SurfaceReference< showNone >::SurfaceReference ( LWSurfaceID _id = 0 )

inline

Constructor, default to an object and no object selected.

Member Function Documentation

bool lwpp::GlobalBase< LWSurfaceFuncs >::_acquireGlobal ( )

inlineprotectedinherited

virtual bool lwpp::GlobalBase< LWSurfaceFuncs >::available ( ) const

inlinevirtualinherited

Check if the global is available.

LWSurface::SurfaceSet lwpp::LWSurface::byName	(	std::string	name,
		std::string	obj
	)		const

inherited

LWSurface::SurfaceSet lwpp::LWSurface::byName ( std::string name ) const

inherited

LWSurface::SurfaceSet lwpp::LWSurface::byObject ( std::string name ) const

inherited

template<bool showNone = true>

int* lwpp::SurfaceReference< showNone >::DataGet ( )

inline

XPanels compatible DataGet.

template<bool showNone = true>

void lwpp::SurfaceReference< showNone >::DataSet ( void * value )

inline

XPanels compatible DataSet.

bool lwpp::LWSurface::exists ( void )

inlineinherited

void lwpp::LWSurface::first ( void )

inlineinherited

LWChanGroupID lwpp::LWSurface::getChannelGroup ( void ) const

inlineinherited

const char* lwpp::LWSurface::getColorVMap ( ) const

inlineinherited

double* lwpp::LWSurface::getDouble ( const char * channel ) const

inlineinherited

LWEnvelopeID lwpp::LWSurface::getEnvelope ( const char * channel ) const

inlineinherited

virtual LWSurfaceFuncs * lwpp::GlobalBase< LWSurfaceFuncs >::getGlobal ( )

inlinevirtualinherited

Get the pointer to the global.

LWSurfaceID lwpp::LWSurface::getID ( void ) const

inlineinherited

LWImageID lwpp::LWSurface::getImage ( const char * channel ) const

inlineinherited

template<bool showNone = true>

int lwpp::SurfaceReference< showNone >::GetIndex ( )

inline

template<bool showNone = true>

LWSurfaceID lwpp::SurfaceReference< showNone >::GetIndexID ( int idx )

inline

return id of item number idx

int lwpp::LWSurface::getInteger ( const char * channel ) const

inlineinherited

NodeEditorID lwpp::LWSurface::getNodeEditor ( )

inlineinherited

const char* lwpp::PopUpCallback::GetSelectedName ( )

inlineinherited

LWTextureID lwpp::LWSurface::getTexture ( const char * channel ) const

inlineinherited

const char* lwpp::LWSurface::name ( ) const

inlineinherited

bool lwpp::LWSurface::next ( void )

inlineinherited

LWSurfaceFuncs * lwpp::GlobalBase< LWSurfaceFuncs >::operator-> ( )

inlineinherited

Get the pointer to the global.

bool lwpp::LWSurface::operator< ( const LWSurface & s ) const

inlineinherited

static int lwpp::PopUpCallback::PopCount ( void * inst )

inlinestaticinherited

PopCount callback for LightWave.

template<bool showNone = true>

virtual size_t lwpp::SurfaceReference< showNone >::popCount ( void )

inlineprotectedvirtual

Return number of items.

Implements lwpp::PopUpCallback.

static const char* lwpp::PopUpCallback::PopName	(	void *	inst,
		int	n
	)

inlinestaticinherited

PopUpName name callback for LightWave.

template<bool showNone = true>

virtual const char* lwpp::SurfaceReference< showNone >::popName ( int idx )

inlineprotectedvirtual

return name of item number idx

Implements lwpp::PopUpCallback.

const char* lwpp::LWSurface::sceneObject ( ) const

inlineinherited

void lwpp::LWSurface::setColorVMap	(	const char *	vmapName,
		int	type
	)

inlineinherited

Member Data Documentation

LWSurfaceFuncs * lwpp::GlobalBase< LWSurfaceFuncs >::globPtr

staticprotectedinherited

Pointer to the global functions.

LWSurfaceID lwpp::LWSurface::id

protectedinherited

int lwpp::PopUpCallback::index

protectedinherited

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

surface.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

template<bool showNone = true> class lwpp::SurfaceReference< showNone >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<bool showNone = true>
class lwpp::SurfaceReference< showNone >