castor3d::ImporterPlugin Class Reference

#include <ImporterPlugin.hpp>

Inheritance diagram for castor3d::ImporterPlugin:

Collaboration diagram for castor3d::ImporterPlugin:

Public Types
using	Extension = castor::Pair< castor::String, castor::String >
Public Types inherited from 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 ** )

Public Member Functions
	CU_DeclareVector (Extension, Extension)
C3D_API	ImporterPlugin (castor::DynamicLibraryUPtr library, Engine *engine)
	Constructor.
C3D_API	~ImporterPlugin () noexcept override
	Destructor.
C3D_API ExtensionArray const &	getExtensions () const
	Retrieves the supported file extensions array.
C3D_API void	addExtension (Extension const &extension)
	adds a supported extension.
Public Member Functions inherited from castor3d::Plugin
virtual C3D_API	~Plugin () noexcept=default
	Destructor.
C3D_API void	getRequiredVersion (Version &version) const
	Retrieves the required version for the plug-in to work correctly.
C3D_API castor::String	getName () const
	Retrieves the plug-in name.
PluginType	getType () const
	Retrieves the plug-in type.
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const

Additional Inherited Members
Protected Member Functions inherited from castor3d::Plugin
C3D_API	Plugin (PluginType type, castor::DynamicLibraryUPtr library, Engine &engine)
	Constructor.
void	load ()
	Calls load function for the plug-in.
void	unload () const noexcept
	Calls unload function for the plug-in.
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructor.
Protected Attributes inherited from castor3d::Plugin
castor::DynamicLibraryUPtr	m_library {}
GetRequiredVersionFunction	m_pfnGetRequiredVersion {}
GetNameFunction	m_pfnGetName {}
OnLoadFunction	m_pfnOnLoad {}
OnUnloadFunction	m_pfnOnUnload {}
PluginType	m_type {}

Member Typedef Documentation

Extension

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

Constructor & Destructor Documentation

ImporterPlugin()

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

Constructor.

Parameters

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

~ImporterPlugin()

C3D_API castor3d::ImporterPlugin::~ImporterPlugin ( )

overridenoexcept

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

(

)

const

Retrieves the supported file extensions array.

Returns

The supported extensions array

---

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

• Castor3D/Plugin/ImporterPlugin.hpp