Castor3D::ImporterPlugin Class Reference

Importer Plugin class. More...

Inheritance diagram for Castor3D::ImporterPlugin:

Collaboration diagram for Castor3D::ImporterPlugin:

Public Types
typedef std::pair< Castor::String, Castor::String >	Extension
Public Types inherited from Castor3D::PluginBase
typedef OnLoadFunction *	POnLoadFunction
typedef OnUnloadFunction *	POnUnloadFunction
typedef GetTypeFunction *	PGetTypeFunction
typedef GetRequiredVersionFunction *	PGetRequiredVersionFunction
typedef GetNameFunction *	PGetNameFunction

Public Member Functions
	DECLARE_VECTOR (Extension, Extension)
C3D_API	ImporterPlugin (Castor::DynamicLibrarySPtr p_library, Engine *p_engine)
	Constructor. More...
virtual C3D_API	~ImporterPlugin ()
	Destructor. More...
void	AttachImporter (ImporterSPtr p_pImporter)
	Attaches the plug-in to the given Importer. More...
void	DetachImporter ()
	Detaches the plug-in from the attached Importer. More...
ImporterSPtr	GetImporter ()
	Retrieves the attached Importer. More...
C3D_API ExtensionArray	GetExtensions ()
	Retrieves the supported file extensions array. More...
Public Member Functions inherited from Castor3D::PluginBase
virtual C3D_API	~PluginBase ()=0
	Destructor. More...
C3D_API void	GetRequiredVersion (Version &p_version) const
	Retrieves the required version for the plug-in to work correctly. More...
C3D_API Castor::String	GetName () const
	Retrieves the plug-in name. More...
ePLUGIN_TYPE	GetType () const
	Retrieves the plug-in type. More...

Friends
class	PluginBase
class	Engine

Additional Inherited Members
Protected Member Functions inherited from Castor3D::PluginBase
C3D_API	PluginBase (ePLUGIN_TYPE p_type, Castor::DynamicLibrarySPtr p_library, Engine &p_engine)
	Constructor. More...
Protected Attributes inherited from Castor3D::PluginBase
PGetRequiredVersionFunction	m_pfnGetRequiredVersion
	The plug-in's version checking function. More...
PGetNameFunction	m_pfnGetName
	The plug-in's name retrieval function. More...
POnLoadFunction	m_pfnOnLoad
	The plug-in's loading function. More...
POnUnloadFunction	m_pfnOnUnload
	The plug-in's unloading function. More...
ePLUGIN_TYPE	m_type
	The plug-in type. More...

Detailed Description

Importer Plugin class.

Author

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Member Typedef Documentation

Extension

typedef std::pair< Castor::String, Castor::String > Castor3D::ImporterPlugin::Extension

Constructor & Destructor Documentation

ImporterPlugin()

C3D_API Castor3D::ImporterPlugin::ImporterPlugin	(	Castor::DynamicLibrarySPtr	p_library,
		Engine *	p_engine
	)

Constructor.

Parameters

[in]	p_library	The shared library holding the plug-in
[in]	p_engine	The engine

~ImporterPlugin()

virtual C3D_API Castor3D::ImporterPlugin::~ImporterPlugin ( )

virtual

Destructor.

Member Function Documentation

AttachImporter()

void Castor3D::ImporterPlugin::AttachImporter ( ImporterSPtr  p_pImporter )

inline

Attaches the plug-in to the given Importer.

Parameters

[in]

p_pImporter

The Importer

DECLARE_VECTOR()

Castor3D::ImporterPlugin::DECLARE_VECTOR	(	Extension	,
		Extension
	)

DetachImporter()

void Castor3D::ImporterPlugin::DetachImporter ( )

inline

Detaches the plug-in from the attached Importer.

Returns

The attached Importer

GetExtensions()

C3D_API ExtensionArray Castor3D::ImporterPlugin::GetExtensions

(

)

Retrieves the supported file extensions array.

Returns

The supported extensions array

GetImporter()

ImporterSPtr Castor3D::ImporterPlugin::GetImporter ( )

inline

Retrieves the attached Importer.

Returns

The attached Importer

Friends And Related Function Documentation

Engine

friend class Engine

friend

PluginBase

friend class PluginBase

friend

---

The documentation for this class was generated from the following file:

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