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

Classe de base des plug-ins. Plus de détails...

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

Graphe de collaboration de Castor3D::Plugin:

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

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

Fonctions membres protégées
C3D_API	Plugin (PluginType p_type, Castor::DynamicLibrarySPtr p_library, Engine &p_engine)
	Constructeur. Plus de détails...

Attributs protégés
PGetRequiredVersionFunction	m_pfnGetRequiredVersion
	La fonction de récupération de la version requise. Plus de détails...
PGetNameFunction	m_pfnGetName
	La fonction de récupération du nom du plug-in. Plus de détails...
POnLoadFunction	m_pfnOnLoad
	La fonction de chargement du plug-in. Plus de détails...
POnUnloadFunction	m_pfnOnUnload
	La fonction de déchargement du plug-in. Plus de détails...
PluginType	m_type
	Le type du plug-in. Plus de détails...

Description détaillée

Classe de base des plug-ins.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

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

Documentation des définitions de type membres

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

Documentation des constructeurs et destructeur

Plugin()

C3D_API Castor3D::Plugin::Plugin ( PluginType  p_type, Castor::DynamicLibrarySPtr  p_library, Engine &  p_engine  )

protected

Constructeur.

Paramètres

[in]	p_type	Le type du plug-in
[in]	p_library	La bibliothèque partagée contenant le plug-in
[in]	p_engine	Le moteur

~Plugin()

virtual C3D_API Castor3D::Plugin::~Plugin ( )

pure virtual

Destructeur.

Documentation des fonctions membres

GetName()

C3D_API Castor::String Castor3D::Plugin::GetName

(

)

const

Récupère le nom du plug-in.

Renvoie

Le nom

GetRequiredVersion()

C3D_API void Castor3D::Plugin::GetRequiredVersion

(

Version &

p_version

)

const

Récupère la version nécessaire au bon fonctionnement du plug-in.

Renvoie

La version

GetType()

PluginType Castor3D::Plugin::GetType ( ) const

inline

Récupère le type du plug-in.

Renvoie

Le type

Références m_type.

Documentation des données membres

m_pfnGetName

PGetNameFunction Castor3D::Plugin::m_pfnGetName

protected

La fonction de récupération du nom du plug-in.

m_pfnGetRequiredVersion

PGetRequiredVersionFunction Castor3D::Plugin::m_pfnGetRequiredVersion

protected

La fonction de récupération de la version requise.

m_pfnOnLoad

POnLoadFunction Castor3D::Plugin::m_pfnOnLoad

protected

La fonction de chargement du plug-in.

m_pfnOnUnload

POnUnloadFunction Castor3D::Plugin::m_pfnOnUnload

protected

La fonction de déchargement du plug-in.

m_type

PluginType Castor3D::Plugin::m_type

protected

Le type du plug-in.

Référencé par GetType().

---

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

• Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Plugin/Plugin.hpp