Assimp::BatchLoader Class Reference

FOR IMPORTER PLUGINS ONLY: A helper class for the pleasure of importers which need to load many extern meshes recursively. More...

List of all members.

Public Member Functions
unsigned int	AddLoadRequest (const std::string &file, unsigned int steps=0, const PropertyMap *map=NULL)
	Add a new file to the list of files to be loaded.
	BatchLoader (IOSystem *pIO)
	Construct a batch loader from a given IO system to be used to acess external files.
aiScene *	GetImport (unsigned int which)
	Get an imported scene.
void	LoadAll ()
	Waits until all scenes have been loaded.
	~BatchLoader ()

---

Detailed Description

FOR IMPORTER PLUGINS ONLY: A helper class for the pleasure of importers which need to load many extern meshes recursively.

The class uses several threads to load these meshes (or at least it could, this has not yet been implemented at the moment).

Note:

The class may not be used by more than one thread

---

Constructor & Destructor Documentation

Assimp::BatchLoader::BatchLoader

(

IOSystem *

pIO

)

Construct a batch loader from a given IO system to be used to acess external files.

Assimp::BatchLoader::~BatchLoader

(

)

---

Member Function Documentation

unsigned int Assimp::BatchLoader::AddLoadRequest	(	const std::string &	file,
		unsigned int	steps = 0,
		const PropertyMap *	map = NULL
	)

Add a new file to the list of files to be loaded.

Parameters:

	file	File to be loaded
	steps	Post-processing steps to be executed on the file
	map	Optional configuration properties

Returns:

'Load request channel' - an unique ID that can later be used to access the imported file data.

See also:

GetImport

aiScene* Assimp::BatchLoader::GetImport

(

unsigned int

which

)

Get an imported scene.

This polls the import from the internal request list. If an import is requested several times, this function can be called several times, too.

Parameters:

which

LRWC returned by AddLoadRequest().

Returns:

NULL if there is no scene with this file name in the queue of the scene hasn't been loaded yet.

void Assimp::BatchLoader::LoadAll

(

)

Waits until all scenes have been loaded.

This returns immediately if no scenes are queued.

---

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

• BaseImporter.h