lwpp::LWSurface Class Reference

#include <surface.h>

Inheritance diagram for lwpp::LWSurface:

Collaboration diagram for lwpp::LWSurface:

List of all members.

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

Public Member Functions
	LWSurface ()
	Default contructor, set this surface to the first surface.
	LWSurface (LWSurfaceID _id)
	Constructor from an existing surface ID.
	LWSurface (const char *objName, const char *surfName)
	Constructor creating a new surface.
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
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	getInteger (const char *channel) const
NodeEditorID	getNodeEditor ()
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)

Protected Member Functions
bool	_acquireGlobal ()

Protected Attributes
LWSurfaceID	id

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

---

Member Typedef Documentation

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

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

---

Constructor & Destructor Documentation

lwpp::LWSurface::LWSurface ( )

inline

Default contructor, set this surface to the first surface.

lwpp::LWSurface::LWSurface ( LWSurfaceID  _id )

inline

Constructor from an existing surface ID.

lwpp::LWSurface::LWSurface ( const char *  objName, const char *  surfName  )

inline

Constructor creating a new surface.

---

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

LWSurface::SurfaceSet lwpp::LWSurface::byName

(

std::string

name

)

const

LWSurface::SurfaceSet lwpp::LWSurface::byObject

(

std::string

name

)

const

bool lwpp::LWSurface::exists ( void  )

inline

void lwpp::LWSurface::first ( void  )

inline

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

inline

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

inline

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

inline

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

inline

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

inlinevirtualinherited

Get the pointer to the global.

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

inline

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

inline

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

inline

NodeEditorID lwpp::LWSurface::getNodeEditor ( )

inline

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

inline

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

inline

bool lwpp::LWSurface::next ( void  )

inline

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

inlineinherited

Get the pointer to the global.

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

inline

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

inline

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

inline

---

Member Data Documentation

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

staticprotectedinherited

Pointer to the global functions.

LWSurfaceID lwpp::LWSurface::id

protected

---

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

• surface.h
• surface.cpp