Assimp: Assimp::BaseImporter Class Reference

Constructor to be privately used by Importer.

Destructor, private as well.

Returns whether the class can handle the format of the given file.

The implementation should be as quick as possible. A check for the file extension is enough. If no suitable loader is found with this strategy, CanRead() is called again, the 'checkSig' parameter set to true this time. Now the implementation is expected to perform a full check of the file structure, possibly searching the first bytes of the file for magic identifiers or keywords.

Parameters

pFile	Path and file name of the file to be examined.
pIOHandler	The IO handler to use for accessing any file.
checkSig	Set to true if this method is called a second time. This time, the implementation may take more time to examine the contents of the file to be loaded for magic bytes, keywords, etc to be able to load files with unknown/not existent file extensions.

Returns

true if the class can read this file, false if not.

Check whether a file starts with one or more magic tokens.

Parameters

pFile	Input file
pIOHandler	IO system to be used
magic	n magic tokens num Size of magic
offset	Offset from file start where tokens are located
Size	of one token, in bytes. Maximally 16 bytes.

Returns

true if one of the given tokens was found

Note

For convinence, the check is also performed for the byte-swapped variant of all tokens (big endian). Only for tokens of size 2,4.

An utility for all text file loaders.

It converts a file to our UTF8 character set. Errors are reported, but ignored.

Parameters

data	File buffer to be converted to UTF8 data. The buffer is resized as appropriate.

An utility for all text file loaders.

It converts a file from our UTF8 character set back to ISO-8859-1. Errors are reported, but ignored.

Parameters

data	File buffer to be converted from UTF8 to ISO-8859-1. The buffer is resized as appropriate.

Utility function to move a std::vector into a aiScene array.

Parameters

vec	The vector to be moved
out	The output pointer to the allocated array.
numOut	The output count of elements copied.

Returns the error description of the last error that occured.

Returns

A description of the last error that occured. An empty string if there was no error.

Extract file extension from a string.

Parameters

pFile

Input file

Returns

Extension without trailing dot, all lowercase

Called by #Importer::GetExtensionList for each loaded importer.

Take the extension list contained in the structure returned by GetInfo and insert all file extensions into the given set.

Parameters

extension

set to collect file extensions in

Called by #Importer::GetImporterInfo to get a description of some loader features.

Importers must provide this information.

Imports the given file into the given scene structure.

The function is expected to throw an ImportErrorException if there is an error. If it terminates normally, the data in aiScene is expected to be correct. Override this function to implement the actual importing.
The output scene must meet the following requirements:

• At least a root node must be there, even if its only purpose is to reference one mesh.
• aiMesh::mPrimitiveTypes may be 0. The types of primitives in the mesh are determined automatically in this case.
• the vertex data is stored in a pseudo-indexed "verbose" format. In fact this means that every vertex that is referenced by a face is unique. Or the other way round: a vertex index may not occur twice in a single aiMesh.
• aiAnimation::mDuration may be -1. Assimp determines the length of the animation automatically in this case as the length of the longest animation channel.
• aiMesh::mBitangents may be NULL if tangents and normals are given. In this case bitangents are computed as the cross product between normal and tangent.
• There needn't be a material. If none is there a default material is generated. However, it is recommended practice for loaders to generate a default material for yourself that matches the default material setting for the file format better than Assimp's generic default material. Note that default materials should be named AI_DEFAULT_MATERIAL_NAME if they're just color-shaded or AI_DEFAULT_TEXTURED_MATERIAL_NAME if they define a (dummy) texture.

If the AI_SCENE_FLAGS_INCOMPLETE-Flag is not set:

• at least one mesh must be there
• there may be no meshes with 0 vertices or faces

This won't be checked (except by the validation step): Assimp will crash if one of the conditions is not met!

Parameters

pFile	Path of the file to be imported.
pScene	The scene object to hold the imported data. NULL is not a valid parameter.
pIOHandler	The IO handler to use for any file access. NULL is not a valid parameter.

Imports the given file and returns the imported data.

If the import succeeds, ownership of the data is transferred to the caller. If the import fails, NULL is returned. The function takes care that any partially constructed data is destroyed beforehand.

Parameters

pImp	Importer object hosting this loader.
pFile	Path of the file to be imported.
pIOHandler	IO-Handler used to open this and possible other files.

Returns

The imported data or NULL if failed. If it failed a human-readable error description can be retrieved by calling GetErrorText()

Note

This function is not intended to be overridden. Implement InternReadFile() to do the import. If an exception is thrown somewhere in InternReadFile(), this function will catch it and transform it into a suitable response to the caller.

A utility for CanRead().

The function searches the header of a file for a specific token and returns true if this token is found. This works for text files only. There is a rudimentary handling of UNICODE files. The comparison is case independent.

Parameters

pIOSystem	IO System to work with
file	File name of the file
tokens	List of tokens to search for
numTokens	Size of the token array
searchBytes	Number of bytes to be searched for the tokens.

Called prior to ReadFile().

The function is a request to the importer to update its configuration basing on the Importer's configuration property list.

Parameters

pImp	Importer instance

Check whether a file has a specific file extension.

Parameters

pFile	Input file
ext0	Extension to check for. Lowercase characters only, no dot!
ext1	Optional second extension
ext2	Optional third extension

Note

Case-insensitive

Utility for text file loaders which copies the contents of the file into a memory buffer and converts it to our UTF8 representation.

Parameters

stream	Stream to read from.
data	Output buffer to be resized and filled with the converted text file data. The buffer is terminated with a binary 0.
mode	Whether it is OK to load empty text files.

Error description in case there was one.

Currently set progress handler.