castor3d::Plugin Class Reference

#include <Plugin.hpp>

Inheritance diagram for castor3d::Plugin:

Collaboration diagram for castor3d::Plugin:

Public Types
typedef OnLoadFunction *	POnLoadFunction
typedef OnUnloadFunction *	POnUnloadFunction
typedef GetTypeFunction *	PGetTypeFunction
typedef GetRequiredVersionFunction *	PGetRequiredVersionFunction
typedef GetNameFunction *	PGetNameFunction

Public Member Functions
virtual C3D_API	~Plugin ()=0
	Destructor. More...
C3D_API void	getRequiredVersion (Version &version) const
	Retrieves the required version for the plug-in to work correctly. More...
C3D_API castor::String	getName () const
	Retrieves the plug-in name. More...
PluginType	getType () const
	Retrieves the plug-in type. More...

Protected Member Functions
C3D_API	Plugin (PluginType type, castor::DynamicLibrarySPtr library, Engine &engine)
	Constructor. More...
void	load ()
	Calls load function for the plug-in. More...
void	unload ()
	Calls unload function for the plug-in. More...

Protected Attributes
PGetRequiredVersionFunction	m_pfnGetRequiredVersion
PGetNameFunction	m_pfnGetName
POnLoadFunction	m_pfnOnLoad
POnUnloadFunction	m_pfnOnUnload
PluginType	m_type
castor::DynamicLibraryWPtr	m_library

Member Typedef Documentation

PGetNameFunction

typedef GetNameFunction* castor3d::Plugin::PGetNameFunction

PGetRequiredVersionFunction

typedef GetRequiredVersionFunction* castor3d::Plugin::PGetRequiredVersionFunction

PGetTypeFunction

typedef GetTypeFunction* castor3d::Plugin::PGetTypeFunction

POnLoadFunction

typedef OnLoadFunction* castor3d::Plugin::POnLoadFunction

POnUnloadFunction

typedef OnUnloadFunction* castor3d::Plugin::POnUnloadFunction

Constructor & Destructor Documentation

Plugin()

C3D_API castor3d::Plugin::Plugin ( PluginType  type, castor::DynamicLibrarySPtr  library, Engine &  engine  )

protected

Constructor.

Parameters

[in]	type	The plug-in type
[in]	library	The shared library holding the plug-in
[in]	engine	The engine

~Plugin()

virtual C3D_API castor3d::Plugin::~Plugin ( )

pure virtual

Destructor.

Member Function Documentation

getName()

C3D_API castor::String castor3d::Plugin::getName

(

)

const

Retrieves the plug-in name.

Returns

The name

getRequiredVersion()

C3D_API void castor3d::Plugin::getRequiredVersion

(

Version &

version

)

const

Retrieves the required version for the plug-in to work correctly.

Parameters

[out]

version

Receives the version.

getType()

PluginType castor3d::Plugin::getType ( ) const

inline

Retrieves the plug-in type.

Returns

The type

References m_type.

load()

void castor3d::Plugin::load ( )

protected

Calls load function for the plug-in.

unload()

void castor3d::Plugin::unload ( )

protected

Calls unload function for the plug-in.

Member Data Documentation

m_library

castor::DynamicLibraryWPtr castor3d::Plugin::m_library

protected

The plug-in library.

m_pfnGetName

PGetNameFunction castor3d::Plugin::m_pfnGetName

protected

The plug-in's name retrieval function.

m_pfnGetRequiredVersion

PGetRequiredVersionFunction castor3d::Plugin::m_pfnGetRequiredVersion

protected

The plug-in's version checking function.

m_pfnOnLoad

POnLoadFunction castor3d::Plugin::m_pfnOnLoad

protected

The plug-in's loading function.

m_pfnOnUnload

POnUnloadFunction castor3d::Plugin::m_pfnOnUnload

protected

The plug-in's unloading function

m_type

PluginType castor3d::Plugin::m_type

protected

The plug-in type.

Referenced by getType().

---

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

• Plugin/Plugin.hpp