castor3d::ImporterFileFactory Class Reference

#include <ImporterFile.hpp>

Public Member Functions
C3D_API	ImporterFileFactory ()
C3D_API ImporterFileUPtr	create (castor::String const &type, castor::String const &name, Engine &engine, castor::Path const &file, Parameters const &parameters, ProgressBar *progress=nullptr) const
	Creates an importer from a file type.
C3D_API ImporterFileUPtr	create (castor::String const &type, castor::String const &name, Scene &scene, castor::Path const &file, Parameters const &parameters, ProgressBar *progress=nullptr) const
	Creates an importer from a file type.
C3D_API ImporterFileUPtr	create (castor::String const &type, Engine &engine, castor::Path const &file, Parameters const &parameters, ProgressBar *progress=nullptr) const
	Creates an importer from a file type.
C3D_API ImporterFileUPtr	create (castor::String const &type, Scene &scene, castor::Path const &file, Parameters const &parameters, ProgressBar *progress=nullptr) const
	Creates an importer from a file type.
void	registerType (castor::String const &type, castor::String const &name, Creator create)
	Registers an file type.
void	unregisterType (castor::String const &type, castor::String const &name) noexcept
	Unregisters an file type.
bool	isTypeRegistered (castor::String const &type) const
	Checks if the given file type is registered.

Constructor & Destructor Documentation

ImporterFileFactory()

C3D_API castor3d::ImporterFileFactory::ImporterFileFactory

(

)

Member Function Documentation

create() [1/4]

C3D_API ImporterFileUPtr castor3d::ImporterFileFactory::create	(	castor::String const &	type,
		castor::String const &	name,
		Engine &	engine,
		castor::Path const &	file,
		Parameters const &	parameters,
		ProgressBar *	progress = nullptr ) const

Creates an importer from a file type.

Parameters

[in]	type	The file type.
[in]	name	The preferred importer name.
[in]	engine	The engine.
[in]	file	The file containing the data to import.
[in]	parameters	The import parameters.
[in]	progress	An optional progress bar.

Returns

The created importer.

Referenced by registerType().

Here is the caller graph for this function:

create() [2/4]

C3D_API ImporterFileUPtr castor3d::ImporterFileFactory::create	(	castor::String const &	type,
		castor::String const &	name,
		Scene &	scene,
		castor::Path const &	file,
		Parameters const &	parameters,
		ProgressBar *	progress = nullptr ) const

Creates an importer from a file type.

Parameters

[in]	type	The file type.
[in]	name	The preferred importer name.
[in]	scene	The parent scene.
[in]	file	The file containing the data to import.
[in]	parameters	The import parameters.
[in]	progress	An optional progress bar.

Returns

The created importer.

create() [3/4]

C3D_API ImporterFileUPtr castor3d::ImporterFileFactory::create	(	castor::String const &	type,
		Engine &	engine,
		castor::Path const &	file,
		Parameters const &	parameters,
		ProgressBar *	progress = nullptr ) const

Creates an importer from a file type.

Parameters

[in]	type	The file type.
[in]	engine	The engine.
[in]	file	The file containing the data to import.
[in]	parameters	The import parameters.
[in]	progress	An optional progress bar.

Returns

The created importer.

create() [4/4]

C3D_API ImporterFileUPtr castor3d::ImporterFileFactory::create	(	castor::String const &	type,
		Scene &	scene,
		castor::Path const &	file,
		Parameters const &	parameters,
		ProgressBar *	progress = nullptr ) const

Creates an importer from a file type.

Parameters

[in]	type	The file type.
[in]	scene	The parent scene.
[in]	file	The file containing the data to import.
[in]	parameters	The import parameters.
[in]	progress	An optional progress bar.

Returns

The created importer.

isTypeRegistered()

bool castor3d::ImporterFileFactory::isTypeRegistered ( castor::String const & type ) const

inline

Checks if the given file type is registered.

Parameters

[in]

type

The file type.

Returns

true if registered.

registerType()

void castor3d::ImporterFileFactory::registerType ( castor::String const & type, castor::String const & name, Creator create )

inline

Registers an file type.

Parameters

[in]	type	The file type.
[in]	name	The importer name.
[in]	create	The object creation function.

References create().

Here is the call graph for this function:

unregisterType()

void castor3d::ImporterFileFactory::unregisterType ( castor::String const & type, castor::String const & name )

inlinenoexcept

Unregisters an file type.

Parameters

[in]	type	The file type.
[in]	name	The importer name.

---

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

• Castor3D/ImporterFile.hpp