libglass::PluginInterface Class Reference

#include <plugin.h>

Inheritance diagram for libglass::PluginInterface:

List of all members.

Protected Member Functions
	PluginInterface ()
virtual	~PluginInterface ()=0
PluginBase *	getPluginBase (PluginId id)
nodeRelation	getNodeRelation (nodeId id) const
Static Protected Member Functions
static const PluginManager *	getPluginManager (void)

---

Detailed Description

This is an interface that should be used by all classes that are related to plugins. There is only one PluginBase per Glass, which should not be directly accessed by the user. This class provides useful methods to find the type of node (so you can set your behaviour accordingly) and to get your plugin base. Use the plugin base to do any kind of interaction with the Glass library (such as PluginBase::sendPacket()).

Note that this interface is not bound to only one PluginBase; so you can use it to access more than one, if you can find some reason to do this.

Definition at line 433 of file plugin.h.

---

Constructor & Destructor Documentation

libglass::PluginInterface::PluginInterface

(

)

[protected]

Constructor.

virtual libglass::PluginInterface::~PluginInterface

(

)

[protected, pure virtual]

Destructor.

---

Member Function Documentation

nodeRelation libglass::PluginInterface::getNodeRelation

(

nodeId

id

)

const [protected]

Gets our node type. Useful if you have different behaviours.

Returns:

The node type.

PluginBase* libglass::PluginInterface::getPluginBase

(

PluginId

id

)

[protected]

Gets a plugin base given its id.

Parameters:

id

The plugin id.

Returns:

A pointer to the PluginBase.

static const PluginManager* libglass::PluginInterface::getPluginManager

(

void

)

[static, protected]

Gets the current Glass. This is useful for static methods.

Returns:

The current PluginManager.

---

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

• plugin.h