castor3d::SceneImporter Class Reference

#include <SceneImporter.hpp>

Inheritance diagram for castor3d::SceneImporter:

Collaboration diagram for castor3d::SceneImporter:

Public Member Functions
C3D_API	SceneImporter (Engine &engine)
	Constructor.
C3D_API bool	import (Scene &scene, ImporterFile *file, Parameters const &parameters, castor::Map< PassComponentTextureFlag, TextureConfiguration > const &textureRemaps)
	Scene import Function.
C3D_API bool	import (Scene &scene, castor::Path const &pathFile, Parameters const &parameters, castor::Map< PassComponentTextureFlag, TextureConfiguration > const &textureRemaps, ProgressBar *progress=nullptr)
	Scene import Function.
C3D_API bool	importAnimations (Scene &scene, ImporterFile *file, Parameters const &parameters)
	Scene animations import Function.
C3D_API bool	importAnimations (Scene &scene, castor::Path const &pathFile, Parameters const &parameters, ProgressBar *progress=nullptr)
	Scene animations import Function.
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const

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

Constructor & Destructor Documentation

SceneImporter()

C3D_API castor3d::SceneImporter::SceneImporter ( Engine & engine )

explicit

Constructor.

Parameters

[in]

engine

The engine.

Member Function Documentation

import() [1/2]

C3D_API bool castor3d::SceneImporter::import	(	Scene &	scene,
		castor::Path const &	pathFile,
		Parameters const &	parameters,
		castor::Map< PassComponentTextureFlag, TextureConfiguration > const &	textureRemaps,
		ProgressBar *	progress = nullptr )

Scene import Function.

Parameters

[out]	scene	Receives the imported data.
[in]	pathFile	The location of the file to import.
[in]	parameters	Import configuration parameters.
[in]	textureRemaps	The imported textures remapping parameters.
[in,out]	progress	Optional progress bar.

Returns

false if any problem occured.

import() [2/2]

C3D_API bool castor3d::SceneImporter::import	(	Scene &	scene,
		ImporterFile *	file,
		Parameters const &	parameters,
		castor::Map< PassComponentTextureFlag, TextureConfiguration > const &	textureRemaps )

Scene import Function.

Parameters

[out]	scene	Receives the imported data.
[in]	file	The location of the file to import.
[in]	parameters	Import configuration parameters.
[in]	textureRemaps	The imported textures remapping parameters.

Returns

false if any problem occured.

importAnimations() [1/2]

C3D_API bool castor3d::SceneImporter::importAnimations	(	Scene &	scene,
		castor::Path const &	pathFile,
		Parameters const &	parameters,
		ProgressBar *	progress = nullptr )

Scene animations import Function.

Parameters

[out]	scene	Receives the imported data.
[in]	pathFile	The location of the file to import.
[in]	parameters	Import configuration parameters.
[in,out]	progress	Optional progress bar.

Returns

false if any problem occured.

importAnimations() [2/2]

C3D_API bool castor3d::SceneImporter::importAnimations	(	Scene &	scene,
		ImporterFile *	file,
		Parameters const &	parameters )

Scene animations import Function.

Parameters

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

Returns

false if any problem occured.

---

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

• Castor3D/Scene/SceneImporter.hpp