Castor3D 0.15.0
Multiplatform 3D engine
Types publics | Fonctions membres publiques | Fonctions membres protégées | Attributs protégés | Liste de tous les membres
Référence de la classe castor3d::Pluginabstract

#include <Plugin.hpp>

Graphe d'héritage de castor3d::Plugin:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::Plugin:
Collaboration graph
[légende]

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.
 
C3D_API void getRequiredVersion (Version &version) const
 Récupère la version nécessaire au bon fonctionnement du plug-in.
 
C3D_API castor::String getName () const
 Récupère le nom du plug-in.
 
PluginType getType () const
 Récupère le type du plug-in.
 

Fonctions membres protégées

C3D_API Plugin (PluginType type, castor::DynamicLibraryUPtr library, Engine &engine)
 Constructeur.
 
void load ()
 Exécute la fonction de chargement du plug-in.
 
void unload ()
 Exécute la fonction de déchargement du plug-in.
 

Attributs protégés

castor::DynamicLibraryUPtr m_library {}
 
PGetRequiredVersionFunction m_pfnGetRequiredVersion
 
PGetNameFunction m_pfnGetName
 
POnLoadFunction m_pfnOnLoad
 
POnUnloadFunction m_pfnOnUnload
 
PluginType m_type
 

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  type,
castor::DynamicLibraryUPtr  library,
Engine engine 
)
protected

Constructeur.

Paramètres
[in]typeLe type du plug-in
[in]libraryLa bibliothèque partagée contenant le plug-in
[in]engineLe 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 version) const

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

Paramètres
[out]versionReçoit 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.

◆ load()

void castor3d::Plugin::load ( )
protected

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

◆ unload()

void castor3d::Plugin::unload ( )
protected

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

Documentation des données membres

◆ m_library

castor::DynamicLibraryUPtr 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 :