Castor3D::PluginBase Class Reference

Plugin Base class. More...

Inheritance diagram for Castor3D::PluginBase:

Collaboration diagram for Castor3D::PluginBase:

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

Public Member Functions
virtual C3D_API	~PluginBase ()=0
	Destructor. More...
C3D_API void	GetRequiredVersion (Version &p_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...
ePLUGIN_TYPE	GetType () const
	Retrieves the plug-in type. More...

Protected Member Functions
C3D_API	PluginBase (ePLUGIN_TYPE p_type, Castor::DynamicLibrarySPtr p_library, Engine &p_engine)
	Constructor. More...

Protected Attributes
PGetRequiredVersionFunction	m_pfnGetRequiredVersion
	The plug-in's version checking function. More...
PGetNameFunction	m_pfnGetName
	The plug-in's name retrieval function. More...
POnLoadFunction	m_pfnOnLoad
	The plug-in's loading function. More...
POnUnloadFunction	m_pfnOnUnload
	The plug-in's unloading function. More...
ePLUGIN_TYPE	m_type
	The plug-in type. More...

Detailed Description

Plugin Base class.

Author

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarks

Manages the base plug-in functions, allows plug-ins to check versions and to register themselves

Member Typedef Documentation

PGetNameFunction

typedef GetNameFunction* Castor3D::PluginBase::PGetNameFunction

PGetRequiredVersionFunction

typedef GetRequiredVersionFunction* Castor3D::PluginBase::PGetRequiredVersionFunction

PGetTypeFunction

typedef GetTypeFunction* Castor3D::PluginBase::PGetTypeFunction

POnLoadFunction

typedef OnLoadFunction* Castor3D::PluginBase::POnLoadFunction

POnUnloadFunction

typedef OnUnloadFunction* Castor3D::PluginBase::POnUnloadFunction

Constructor & Destructor Documentation

PluginBase()

C3D_API Castor3D::PluginBase::PluginBase ( ePLUGIN_TYPE  p_type, Castor::DynamicLibrarySPtr  p_library, Engine &  p_engine  )

protected

Constructor.

Parameters

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

~PluginBase()

virtual C3D_API Castor3D::PluginBase::~PluginBase ( )

pure virtual

Destructor.

Member Function Documentation

GetName()

C3D_API Castor::String Castor3D::PluginBase::GetName

(

)

const

Retrieves the plug-in name.

Returns

The name

GetRequiredVersion()

C3D_API void Castor3D::PluginBase::GetRequiredVersion

(

Version &

p_version

)

const

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

Returns

The version

GetType()

ePLUGIN_TYPE Castor3D::PluginBase::GetType ( ) const

inline

Retrieves the plug-in type.

Returns

The type

References m_type.

Member Data Documentation

m_pfnGetName

PGetNameFunction Castor3D::PluginBase::m_pfnGetName

protected

The plug-in's name retrieval function.

m_pfnGetRequiredVersion

PGetRequiredVersionFunction Castor3D::PluginBase::m_pfnGetRequiredVersion

protected

The plug-in's version checking function.

m_pfnOnLoad

POnLoadFunction Castor3D::PluginBase::m_pfnOnLoad

protected

The plug-in's loading function.

m_pfnOnUnload

POnUnloadFunction Castor3D::PluginBase::m_pfnOnUnload

protected

The plug-in's unloading function.

m_type

ePLUGIN_TYPE Castor3D::PluginBase::m_type

protected

The plug-in type.

Referenced by GetType().

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Plugin.hpp