Référence de la classe castor3d::ImporterPlugin

#include <ImporterPlugin.hpp>

Graphe d'héritage de castor3d::ImporterPlugin:

Graphe de collaboration de castor3d::ImporterPlugin:

Types publics
using	Extension = castor::Pair< castor::String, castor::String >
Types publics hérités de castor3d::Plugin
using	OnLoadFunction = void ( * )( Engine *, Plugin * )
	< Signature for the plug-in's loading function
using	OnUnloadFunction = void ( * )( Engine * )noexcept
	Signature for the plug-in's type retrieval function.
using	GetTypeFunction = void ( * )( PluginType * )
	Signature for the plug-in's version checking function.
using	GetRequiredVersionFunction = void ( * )( Version * version )
	Signature for the plug-in's name retrieval function.
using	GetNameFunction = void ( * )( char const ** )

Fonctions membres publiques
	CU_DeclareVector (Extension, Extension)
C3D_API	ImporterPlugin (castor::DynamicLibraryUPtr library, Engine *engine)
	Constructeur.
C3D_API	~ImporterPlugin () noexcept override
	Destructeur.
C3D_API ExtensionArray const &	getExtensions () const
	Récupère le tableau des extensions supportées.
C3D_API void	addExtension (Extension const &extension)
	Ajoute une extension supportée.
Fonctions membres publiques hérités de castor3d::Plugin
virtual C3D_API	~Plugin () noexcept=default
	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 publiques hérités de castor::OwnedBy< Engine >
Engine *	getOwner () const
	L'objet propriétaire.

Membres hérités additionnels
Fonctions membres protégées hérités de castor3d::Plugin
C3D_API	Plugin (PluginType type, castor::DynamicLibraryUPtr library, Engine &engine)
	Constructeur.
void	load ()
	Exécute la fonction de chargement du plug-in.
void	unload () const noexcept
	Exécute la fonction de déchargement du plug-in.
Fonctions membres protégées hérités de castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructeur.
Attributs protégés hérités de castor3d::Plugin
castor::DynamicLibraryUPtr	m_library {}
GetRequiredVersionFunction	m_pfnGetRequiredVersion {}
GetNameFunction	m_pfnGetName {}
OnLoadFunction	m_pfnOnLoad {}
OnUnloadFunction	m_pfnOnUnload {}
PluginType	m_type {}

Documentation des définitions de type membres

Extension

using castor3d::ImporterPlugin::Extension = castor::Pair< castor::String, castor::String >

Documentation des constructeurs et destructeur

ImporterPlugin()

C3D_API castor3d::ImporterPlugin::ImporterPlugin	(	castor::DynamicLibraryUPtr	library,
		Engine *	engine )

Constructeur.

Paramètres

[in]	library	La bibliothèque partagée contenant le plug-in
[in]	engine	Le moteur

~ImporterPlugin()

C3D_API castor3d::ImporterPlugin::~ImporterPlugin ( )

overridenoexcept

Destructeur.

Documentation des fonctions membres

addExtension()

C3D_API void castor3d::ImporterPlugin::addExtension

(

Extension const &

extension

)

Ajoute une extension supportée.

Paramètres

[in]

extension

L'extension.

CU_DeclareVector()

castor3d::ImporterPlugin::CU_DeclareVector	(	Extension	,
		Extension	)

getExtensions()

C3D_API ExtensionArray const & castor3d::ImporterPlugin::getExtensions

(

)

const

Récupère le tableau des extensions supportées.

Renvoie

Le tableau d'extensions supportées

---

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

• Castor3D/Plugin/ImporterPlugin.hpp