castor3d::AnimationImporter Class Reference

#include <AnimationImporter.hpp>

Inheritance diagram for castor3d::AnimationImporter:

Collaboration diagram for castor3d::AnimationImporter:

Public Member Functions
virtual	~AnimationImporter ()=default
C3D_API	AnimationImporter (Engine &engine, castor::String const &prefix)
	Constructor.
C3D_API bool	importData (SkeletonAnimation &animation, ImporterFile *file, Parameters const &parameters)
	SkeletonAnimation import function.
C3D_API bool	importData (MeshAnimation &animation, ImporterFile *file, Parameters const &parameters)
	MeshAnimation import function.
C3D_API bool	importData (SceneNodeAnimation &animation, ImporterFile *file, Parameters const &parameters)
	SceneNodeAnimation import function.
C3D_API bool	importData (SceneNodeAnimation &animation, castor::Path const &pathFile, Parameters const &parameters)
	SceneNodeAnimation import function.
C3D_API bool	importData (TextureAnimation &animation, ImporterFile *file, Parameters const &parameters)
	TextureAnimation import function.
C3D_API bool	importData (TextureAnimation &animation, castor::Path const &pathFile, Parameters const &parameters)
	TextureAnimation 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 (SkeletonAnimation &animation, castor::Path const &pathFile, Parameters const &parameters)
	SkeletonAnimation import function.
static C3D_API bool	importData (MeshAnimation &animation, castor::Path const &pathFile, Parameters const &parameters)
	MeshAnimation import function.

Protected Member Functions
virtual C3D_API bool	doImportSkeleton (SkeletonAnimation &skeleton)=0
	SkeletonAnimation import Function.
virtual C3D_API bool	doImportMesh (MeshAnimation &mesh)=0
	MeshAnimation import function.
virtual C3D_API bool	doImportNode (SceneNodeAnimation &node)=0
	SceneNodeAnimation import Function.
virtual C3D_API bool	doImportTexture (TextureAnimation &texture)=0
	TextureAnimation import Function.
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner) noexcept
	Constructor.

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

Constructor & Destructor Documentation

~AnimationImporter()

virtual castor3d::AnimationImporter::~AnimationImporter ( )

virtualdefault

AnimationImporter()

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

explicit

Constructor.

Parameters

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

Member Function Documentation

doImportMesh()

virtual C3D_API bool castor3d::AnimationImporter::doImportMesh ( MeshAnimation & mesh )

protectedpure virtual

MeshAnimation import function.

Parameters

[out]

mesh

Receives the imported data.

Returns

false if any problem occured.

doImportNode()

virtual C3D_API bool castor3d::AnimationImporter::doImportNode ( SceneNodeAnimation & node )

protectedpure virtual

SceneNodeAnimation import Function.

Parameters

[out]

node

Receives the imported data.

Returns

false if any problem occured.

doImportSkeleton()

virtual C3D_API bool castor3d::AnimationImporter::doImportSkeleton ( SkeletonAnimation & skeleton )

protectedpure virtual

SkeletonAnimation import Function.

Parameters

[out]

skeleton

Receives the imported data.

Returns

false if any problem occured.

doImportTexture()

virtual C3D_API bool castor3d::AnimationImporter::doImportTexture ( TextureAnimation & texture )

protectedpure virtual

TextureAnimation import Function.

Parameters

[out]

texture

Receives the imported data.

Returns

false if any problem occured.

getPrefix()

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

inlinenoexcept

References m_prefix.

importData() [1/8]

static C3D_API bool castor3d::AnimationImporter::importData ( MeshAnimation & animation, castor::Path const & pathFile, Parameters const & parameters )

static

MeshAnimation import function.

Parameters

[out]	animation	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() [2/8]

C3D_API bool castor3d::AnimationImporter::importData	(	MeshAnimation &	animation,
		ImporterFile *	file,
		Parameters const &	parameters )

MeshAnimation import function.

Parameters

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

Returns

false if any problem occured.

importData() [3/8]

C3D_API bool castor3d::AnimationImporter::importData	(	SceneNodeAnimation &	animation,
		castor::Path const &	pathFile,
		Parameters const &	parameters )

SceneNodeAnimation import function.

Parameters

[out]	animation	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() [4/8]

C3D_API bool castor3d::AnimationImporter::importData	(	SceneNodeAnimation &	animation,
		ImporterFile *	file,
		Parameters const &	parameters )

SceneNodeAnimation import function.

Parameters

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

Returns

false if any problem occured.

importData() [5/8]

static C3D_API bool castor3d::AnimationImporter::importData ( SkeletonAnimation & animation, castor::Path const & pathFile, Parameters const & parameters )

static

SkeletonAnimation import function.

Parameters

[out]	animation	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() [6/8]

C3D_API bool castor3d::AnimationImporter::importData	(	SkeletonAnimation &	animation,
		ImporterFile *	file,
		Parameters const &	parameters )

SkeletonAnimation import function.

Parameters

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

Returns

false if any problem occured.

importData() [7/8]

C3D_API bool castor3d::AnimationImporter::importData	(	TextureAnimation &	animation,
		castor::Path const &	pathFile,
		Parameters const &	parameters )

TextureAnimation import function.

Parameters

[out]	animation	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() [8/8]

C3D_API bool castor3d::AnimationImporter::importData	(	TextureAnimation &	animation,
		ImporterFile *	file,
		Parameters const &	parameters )

TextureAnimation import function.

Parameters

[out]	animation	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::AnimationImporter::m_file {}

protected

m_parameters

Parameters castor3d::AnimationImporter::m_parameters

protected

Import configuration parameters.

m_prefix

castor::String castor3d::AnimationImporter::m_prefix

protected

Referenced by getPrefix().

---

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

• Castor3D/Animation/AnimationImporter.hpp