castor3d::MeshImporter Class Reference

#include <MeshImporter.hpp>

Inheritance diagram for castor3d::MeshImporter:

Collaboration diagram for castor3d::MeshImporter:

Public Member Functions
virtual	~MeshImporter ()=default
C3D_API	MeshImporter (Engine &engine, castor::String const &prefix)
	Constructor.
C3D_API MeshRes	importData (castor::String const &name, Scene &scene, ImporterFile *file, Parameters const &parameters, bool forceImport)
	Mesh import Function.
C3D_API bool	importData (Mesh &mesh, ImporterFile *file, Parameters const &parameters, bool forceImport)
	Mesh import Function.
castor::StringView	getPrefix () const noexcept
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const noexcept
void	setOwner (Engine &owner) noexcept

Static Public Member Functions
static C3D_API bool	importData (Mesh &mesh, castor::Path const &pathFile, Parameters const &parameters, bool forceImport)
	Mesh import Function.

Protected Attributes
castor::String	m_prefix
ImporterFile *	m_file {}
MeshPtrStrMap	m_meshes
Parameters	m_parameters

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner) noexcept
	Constructor.

Constructor & Destructor Documentation

~MeshImporter()

virtual castor3d::MeshImporter::~MeshImporter ( )

virtualdefault

MeshImporter()

C3D_API castor3d::MeshImporter::MeshImporter ( Engine & engine, castor::String const & prefix )

explicit

Constructor.

Parameters

[in]	engine	The engine.
[in]	prefix	The prefix used for logging.

Member Function Documentation

getPrefix()

castor::StringView castor3d::MeshImporter::getPrefix ( ) const

inlinenoexcept

References m_prefix.

importData() [1/3]

C3D_API MeshRes castor3d::MeshImporter::importData	(	castor::String const &	name,
		Scene &	scene,
		ImporterFile *	file,
		Parameters const &	parameters,
		bool	forceImport )

Mesh import Function.

Parameters

[out]	name	The Mesh name.
[out]	scene	The parent scene.
[in]	file	The location of the file to import.
[in]	parameters	Import configuration parameters.
[in]	forceImport	Tells if the mesh needs to be imported even if it's already filled.

Returns

The imported Mesh, nullptr if any problem occured.

importData() [2/3]

static C3D_API bool castor3d::MeshImporter::importData ( Mesh & mesh, castor::Path const & pathFile, Parameters const & parameters, bool forceImport )

static

Mesh import Function.

Parameters

[out]	mesh	Receives the imported data.
[in]	pathFile	The location of the file to import.
[in]	parameters	Import configuration parameters.
[in]	forceImport	Tells if the mesh needs to be imported even if it's already filled.

Returns

false if any problem occured.

importData() [3/3]

C3D_API bool castor3d::MeshImporter::importData	(	Mesh &	mesh,
		ImporterFile *	file,
		Parameters const &	parameters,
		bool	forceImport )

Mesh import Function.

Parameters

[out]	mesh	Receives the imported data.
[in]	file	The location of the file to import.
[in]	parameters	Import configuration parameters.
[in]	forceImport	Tells if the mesh needs to be imported even if it's already filled.

Returns

false if any problem occured.

Member Data Documentation

m_file

ImporterFile* castor3d::MeshImporter::m_file {}

protected

m_meshes

MeshPtrStrMap castor3d::MeshImporter::m_meshes

protected

The loaded meshes.

m_parameters

Parameters castor3d::MeshImporter::m_parameters

protected

Import configuration parameters.

m_prefix

castor::String castor3d::MeshImporter::m_prefix

protected

Referenced by getPrefix().

---

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

• Castor3D/Model/Mesh/MeshImporter.hpp