castor3d::SkeletonImporter Class Reference

#include <SkeletonImporter.hpp>

Inheritance diagram for castor3d::SkeletonImporter:

Collaboration diagram for castor3d::SkeletonImporter:

Public Member Functions
virtual	~SkeletonImporter ()=default
C3D_API	SkeletonImporter (Engine &engine, castor::String const &prefix)
	Constructor.
C3D_API SkeletonRes	importData (castor::String const &name, Scene &scene, ImporterFile *file, Parameters const &parameters)
	Skeleton import Function.
C3D_API bool	importData (Skeleton &skeleton, ImporterFile *file, Parameters const &parameters)
	Skeleton 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 (Skeleton &skeleton, castor::Path const &pathFile, Parameters const &parameters)
	Skeleton import Function.

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

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

Constructor & Destructor Documentation

~SkeletonImporter()

virtual castor3d::SkeletonImporter::~SkeletonImporter ( )

virtualdefault

SkeletonImporter()

C3D_API castor3d::SkeletonImporter::SkeletonImporter ( 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::SkeletonImporter::getPrefix ( ) const

inlinenoexcept

References m_prefix.

importData() [1/3]

C3D_API SkeletonRes castor3d::SkeletonImporter::importData	(	castor::String const &	name,
		Scene &	scene,
		ImporterFile *	file,
		Parameters const &	parameters )

Skeleton import Function.

Parameters

[out]	name	The Skeleton name.
[out]	scene	The parent scene.
[in]	file	The location of the file to import.
[in]	parameters	Import configuration parameters.

Returns

The imported Skeleton, nullptr if any problem occured.

importData() [2/3]

static C3D_API bool castor3d::SkeletonImporter::importData ( Skeleton & skeleton, castor::Path const & pathFile, Parameters const & parameters )

static

Skeleton import Function.

Parameters

[out]	skeleton	Receives the imported data.
[in]	pathFile	The location of the file to import.
[in]	parameters	Import configuration parameters.

Returns

false if any problem occured.

importData() [3/3]

C3D_API bool castor3d::SkeletonImporter::importData	(	Skeleton &	skeleton,
		ImporterFile *	file,
		Parameters const &	parameters )

Skeleton import Function.

Parameters

[out]	skeleton	Receives the imported data.
[in]	file	The location of the file to import.
[in]	parameters	Import configuration parameters.

Returns

false if any problem occured.

Member Data Documentation

m_file

ImporterFile* castor3d::SkeletonImporter::m_file {}

protected

m_parameters

Parameters castor3d::SkeletonImporter::m_parameters

protected

Import configuration parameters.

m_prefix

castor::String castor3d::SkeletonImporter::m_prefix

protected

Referenced by getPrefix().

---

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

• Castor3D/Model/Skeleton/SkeletonImporter.hpp