lwpp::comRingCommunicator Class Reference

#include <comring.h>

Inheritance diagram for lwpp::comRingCommunicator:

Collaboration diagram for lwpp::comRingCommunicator:

List of all members.

Public Member Functions
	comRingCommunicator ()
	comRingCommunicator (const char *topic)
virtual	~comRingCommunicator ()
virtual bool	available () const
	Check if the global is available.
virtual LWComRing *	getGlobal ()
	Get the pointer to the global.
LWComRing *	operator-> ()
	Get the pointer to the global.
bool	ringAttach (const char *topic)
	Attach to a ComRing to receive messages.
void	ringDetach (const char *topic)
	Detach from a comring to stop receiving messages.
void	ringMessage (const char *topic, int eventCode, void *eventData=0)
	Send a message to a ComRing.

Protected Member Functions
bool	_acquireGlobal ()
virtual void	RingEvent (void *portData, int eventCode, void *eventData)
	Receive an event in the ComRing.

Static Protected Member Functions
static void	RingEventCB (void *clientData, void *portData, int eventCode, void *eventData)
	The static callback for LightWave.

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

---

Detailed Description

Class to add support for the Communication Ring to plugins

 You must inherit this class in EVERY plugin where you'd want to use a ComRing

---

Constructor & Destructor Documentation

lwpp::comRingCommunicator::comRingCommunicator ( )

inline

lwpp::comRingCommunicator::comRingCommunicator ( const char *  topic )

inline

Parameters:

[in]

topic

The name/topic of the ComRing to attach to

virtual lwpp::comRingCommunicator::~comRingCommunicator ( )

inlinevirtual

---

Member Function Documentation

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

inlineprotectedinherited

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

inlinevirtualinherited

Check if the global is available.

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

inlinevirtualinherited

Get the pointer to the global.

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

inlineinherited

Get the pointer to the global.

bool lwpp::comRingCommunicator::ringAttach ( const char *  topic )

inline

Attach to a ComRing to receive messages.

void lwpp::comRingCommunicator::ringDetach ( const char *  topic )

inline

Detach from a comring to stop receiving messages.

virtual void lwpp::comRingCommunicator::RingEvent ( void *  portData, int  eventCode, void *  eventData  )

inlineprotectedvirtual

Receive an event in the ComRing.

This needs to be implemented by the derived class if you want to receive events.

static void lwpp::comRingCommunicator::RingEventCB ( void *  clientData, void *  portData, int  eventCode, void *  eventData  )

inlinestaticprotected

The static callback for LightWave.

void lwpp::comRingCommunicator::ringMessage ( const char *  topic, int  eventCode, void *  eventData = 0  )

inline

Send a message to a ComRing.

---

Member Data Documentation

LWComRing * lwpp::GlobalBase< LWComRing >::globPtr

staticprotectedinherited

Pointer to the global functions.

---

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

• comring.h