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 &engine)
	Constructeur. Plus de détails...
void	load ()
	Exécute la fonction de chargement du plug-in. Plus de détails...
void	unload ()
	Exécute la fonction de déchargement du plug-in. Plus de détails...

Attributs protégés
PGetRequiredVersionFunction	m_pfnGetRequiredVersion
PGetNameFunction	m_pfnGetName
POnLoadFunction	m_pfnOnLoad
POnUnloadFunction	m_pfnOnUnload
PluginType	m_type
castor::DynamicLibraryWPtr	m_library

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 &  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]	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 load(), m_type, et unload().

Voici le graphe d'appel pour cette fonction :

load()

void castor3d::Plugin::load ( )

protected

Exécute la fonction de chargement du plug-in.

Référencé par getType().

Voici le graphe des appelants de cette fonction :

unload()

void castor3d::Plugin::unload ( )

protected

Exécute la fonction de déchargement du plug-in.

Référencé par getType().

Voici le graphe des appelants de cette fonction :

Documentation des données membres

m_library

castor::DynamicLibraryWPtr castor3d::Plugin::m_library

protected

La bibliothèque du plug-in.

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 :

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