Référence de la classe Castor3D::PluginBase

Classe de base des plugins. Plus de détails...

Graphe d'héritage de Castor3D::PluginBase:

Types publics
typedef GetTypeFunction *	PGetTypeFunction
typedef GetRequiredVersionFunction *	PGetRequiredVersionFunction
typedef GetNameFunction *	PGetNameFunction

Fonctions membres publiques
virtual	~PluginBase ()=0
	Destructeur. Plus de détails...
void	GetRequiredVersion (Version &p_version) const
	Récupère la version nécessaire au bon fonctionnement du plugin. Plus de détails...
Castor::String	GetName () const
	Récupère le nom du plugin. Plus de détails...
ePLUGIN_TYPE	GetType () const
	Récupère le type du plugin. Plus de détails...

Fonctions membres protégées
	PluginBase (ePLUGIN_TYPE p_eType, Castor::DynamicLibrarySPtr p_pLibrary)
	Constructeur. Plus de détails...
	PluginBase (PluginBase const &p_plugin)
	Constructeur par copie. Plus de détails...
	PluginBase (PluginBase &&p_plugin)
	Constructeur par déplacement. Plus de détails...
PluginBase &	operator= (PluginBase const &p_plugin)
	Opérateur d'affectation par copie. Plus de détails...
PluginBase &	operator= (PluginBase &&p_plugin)
	Opérateur d'affectation par déplacement. Plus de détails...

Attributs protégés
PGetRequiredVersionFunction	m_pfnGetRequiredVersion
	< The plugin's version checking function Plus de détails...
PGetNameFunction	m_pfnGetName
	The plugin type. Plus de détails...
ePLUGIN_TYPE	m_eType

Description détaillée

Classe de base des plugins.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

Gère les fonctions de base d'un plugin, permet aux plugins de faire des vérifications de version et de s'enregistrer auprès du moteur

Documentation des définitions de type membres

typedef GetNameFunction* Castor3D::PluginBase::PGetNameFunction

typedef GetRequiredVersionFunction* Castor3D::PluginBase::PGetRequiredVersionFunction

typedef GetTypeFunction* Castor3D::PluginBase::PGetTypeFunction

Documentation des constructeurs et destructeur

Castor3D::PluginBase::PluginBase ( ePLUGIN_TYPE  p_eType, Castor::DynamicLibrarySPtr  p_pLibrary  )

protected

Constructeur.

Paramètres

[in]	p_eType	Le type du plugin
[in]	p_pLibrary	La librairie partagée contenant le plugin

virtual Castor3D::PluginBase::~PluginBase ( )

pure virtual

Destructeur.

Castor3D::PluginBase::PluginBase ( PluginBase const &  p_plugin )

protected

Constructeur par copie.

Paramètres

[in]

p_plugin

L'objet Plugin à copier

Castor3D::PluginBase::PluginBase ( PluginBase &&  p_plugin )

protected

Constructeur par déplacement.

Paramètres

[in]

p_plugin

L'objet Plugin à déplacer

Documentation des fonctions membres

Castor::String Castor3D::PluginBase::GetName

(

)

const

Récupère le nom du plugin.

Renvoie

Le nom

void Castor3D::PluginBase::GetRequiredVersion

(

Version &

p_version

)

const

Récupère la version nécessaire au bon fonctionnement du plugin.

Renvoie

La version

ePLUGIN_TYPE Castor3D::PluginBase::GetType ( ) const

inline

Récupère le type du plugin.

Renvoie

Le type

PluginBase& Castor3D::PluginBase::operator= ( PluginBase const &  p_plugin )

protected

Opérateur d'affectation par copie.

Paramètres

[in]

p_plugin

L'objet Plugin à copier

Renvoie

Une référence sur cet objet Plugin

PluginBase& Castor3D::PluginBase::operator= ( PluginBase &&  p_plugin )

protected

Opérateur d'affectation par déplacement.

Paramètres

[in]

p_plugin

L'objet Plugin à déplacer

Renvoie

Une référence sur cet objet Plugin

Documentation des données membres

ePLUGIN_TYPE Castor3D::PluginBase::m_eType

protected

PGetNameFunction Castor3D::PluginBase::m_pfnGetName

protected

The plugin type.

PGetRequiredVersionFunction Castor3D::PluginBase::m_pfnGetRequiredVersion

protected

< The plugin's version checking function

The plugin's name retrieval function

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Y:/projets/Castor3D/source/Core/Castor3D/Src/Plugin.hpp