#include <ImporterPlugin.hpp>

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::Plugin
typedef OnLoadFunction *	POnLoadFunction

typedef OnUnloadFunction *	POnUnloadFunction

typedef GetTypeFunction *	PGetTypeFunction

typedef GetRequiredVersionFunction *	PGetRequiredVersionFunction

typedef GetNameFunction *	PGetNameFunction

Public Member Functions
	CU_DeclareVector (Extension, Extension)

C3D_API	ImporterPlugin (castor::DynamicLibrarySPtr library, Engine *engine)
	Constructor. More...

C3D_API	~ImporterPlugin () override
	Destructor. More...

C3D_API ExtensionArray const &	getExtensions ()
	Retrieves the supported file extensions array. More...

C3D_API void	addExtension (Extension const &extension)
	adds a supported extension. More...

Public Member Functions inherited from castor3d::Plugin
virtual C3D_API	~Plugin ()=0
	Destructor. More...

C3D_API void	getRequiredVersion (Version &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...

PluginType	getType () const
	Retrieves the plug-in type. More...

Friends
class	Plugin

class	Engine

Additional Inherited Members
Protected Member Functions inherited from castor3d::Plugin
C3D_API	Plugin (PluginType type, castor::DynamicLibrarySPtr library, Engine &engine)
	Constructor. More...

void	load ()
	Calls load function for the plug-in. More...

void	unload ()
	Calls unload function for the plug-in. More...

Protected Attributes inherited from castor3d::Plugin
PGetRequiredVersionFunction	m_pfnGetRequiredVersion

PGetNameFunction	m_pfnGetName

POnLoadFunction	m_pfnOnLoad

POnUnloadFunction	m_pfnOnUnload

PluginType	m_type

castor::DynamicLibraryWPtr	m_library

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	library,
		Engine *	engine
	)

Constructor.

Parameters

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

◆ ~ImporterPlugin()

C3D_API castor3d::ImporterPlugin::~ImporterPlugin ( )

override

Destructor.

Member Function Documentation

◆ addExtension()

C3D_API void castor3d::ImporterPlugin::addExtension ( Extension const & extension )

adds a supported extension.

Parameters

[in] extension The extension.

◆ CU_DeclareVector()

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

◆ getExtensions()

C3D_API ExtensionArray const & castor3d::ImporterPlugin::getExtensions ( )

Retrieves the supported file extensions array.

Returns: The supported extensions array

Friends And Related Function Documentation

◆ Engine

friend class Engine

friend

◆ Plugin

friend class Plugin