Assimp
v4.1. (December 2018)
|
Implementation of the Plain-C API. More...
Classes | |
struct | Assimp::mpred |
Stores the LogStream objects for all active C log streams. More... | |
class | LogToCallbackRedirector |
Namespaces | |
Assimp | |
MACHINE-GENERATED by scripts/ICFImporter/CppGenerator.py. | |
Typedefs | |
typedef std::map< aiLogStream, Assimp::LogStream *, mpred > | Assimp::LogStreamMap |
typedef std::list< Assimp::LogStream * > | Assimp::PredefLogStreamMap |
Stores the LogStream objects allocated by aiGetPredefinedLogStream. More... | |
typedef BatchLoader::PropertyMap | Assimp::PropertyMap |
Functions | |
ASSIMP_API const aiScene * | aiApplyCustomizedPostProcessing (const aiScene *scene, BaseProcess *process, bool requestValidation) |
ASSIMP_API const aiScene * | aiApplyPostProcessing (const aiScene *pScene, unsigned int pFlags) |
ASSIMP_API void | aiAttachLogStream (const aiLogStream *stream) |
ASSIMP_API aiPropertyStore * | aiCreatePropertyStore (void) |
Create an empty property store. More... | |
ASSIMP_API void | aiCreateQuaternionFromMatrix (aiQuaternion *quat, const aiMatrix3x3 *mat) |
ASSIMP_API void | aiDecomposeMatrix (const aiMatrix4x4 *mat, aiVector3D *scaling, aiQuaternion *rotation, aiVector3D *position) |
ASSIMP_API void | aiDetachAllLogStreams (void) |
Detach all active log streams from the libraries' logging system. More... | |
ASSIMP_API aiReturn | aiDetachLogStream (const aiLogStream *stream) |
ASSIMP_API void | aiEnableVerboseLogging (aiBool d) |
Enable verbose logging. More... | |
const char * | aiGetErrorString () |
Returns the error text of the last failed import process. More... | |
void | aiGetExtensionList (aiString *szOut) |
ASSIMP_API C_STRUCT const aiImporterDesc * | aiGetImporterDesc (const char *extension) |
Returns the Importer description for a given extension. More... | |
size_t | aiGetImportFormatCount (void) |
Returns the number of import file formats available in the current Assimp build. More... | |
const aiImporterDesc * | aiGetImportFormatDescription (size_t pIndex) |
Returns a description of the nth import file format. More... | |
void | aiGetMemoryRequirements (const C_STRUCT aiScene *pIn, C_STRUCT aiMemoryInfo *in) |
Get the approximated storage required by an imported asset. More... | |
ASSIMP_API aiLogStream | aiGetPredefinedLogStream (aiDefaultLogStream pStream, const char *file) |
ASSIMP_API void | aiIdentityMatrix3 (aiMatrix3x3 *mat) |
ASSIMP_API void | aiIdentityMatrix4 (aiMatrix4x4 *mat) |
const aiScene * | aiImportFile (const char *pFile, unsigned int pFlags) |
Reads the given file and returns its content. More... | |
const aiScene * | aiImportFileEx (const char *pFile, unsigned int pFlags, aiFileIO *pFS) |
const aiScene * | aiImportFileExWithProperties (const char *pFile, unsigned int pFlags, aiFileIO *pFS, const aiPropertyStore *props) |
const aiScene * | aiImportFileFromMemory (const char *pBuffer, unsigned int pLength, unsigned int pFlags, const char *pHint) |
Reads the given file from a given memory buffer,. More... | |
const aiScene * | aiImportFileFromMemoryWithProperties (const char *pBuffer, unsigned int pLength, unsigned int pFlags, const char *pHint, const aiPropertyStore *props) |
aiBool | aiIsExtensionSupported (const char *szExtension) |
Returns whether a given file extension is supported by ASSIMP. More... | |
ASSIMP_API void | aiMultiplyMatrix3 (aiMatrix3x3 *dst, const aiMatrix3x3 *src) |
ASSIMP_API void | aiMultiplyMatrix4 (aiMatrix4x4 *dst, const aiMatrix4x4 *src) |
void | aiReleaseImport (const aiScene *pScene) |
ASSIMP_API void | aiReleasePropertyStore (aiPropertyStore *p) |
ASSIMP_API void | aiSetImportPropertyFloat (aiPropertyStore *p, const char *szName, ai_real value) |
ASSIMP_API void | aiSetImportPropertyInteger (aiPropertyStore *p, const char *szName, int value) |
ASSIMP_API void | aiSetImportPropertyMatrix (aiPropertyStore *p, const char *szName, const C_STRUCT aiMatrix4x4 *mat) |
ASSIMP_API void | aiSetImportPropertyString (aiPropertyStore *p, const char *szName, const C_STRUCT aiString *st) |
ASSIMP_API void | aiTransformVecByMatrix3 (aiVector3D *vec, const aiMatrix3x3 *mat) |
ASSIMP_API void | aiTransformVecByMatrix4 (aiVector3D *vec, const aiMatrix4x4 *mat) |
ASSIMP_API void | aiTransposeMatrix3 (aiMatrix3x3 *mat) |
ASSIMP_API void | aiTransposeMatrix4 (aiMatrix4x4 *mat) |
void | CallbackToLogRedirector (const char *msg, char *dt) |
void | Assimp::DeleteImporterInstanceList (std::vector< BaseImporter * > &out) |
will delete all registered importers. More... | |
void | Assimp::GetImporterInstanceList (std::vector< BaseImporter * > &out) |
will return all registered importers. More... | |
void | ReportSceneNotFoundError () |
Variables | |
static LogStreamMap | Assimp::gActiveLogStreams |
Local storage of all active log streams. More... | |
static std::string | Assimp::gLastErrorString |
Error message of the last failed import process. More... | |
static std::mutex | gLogStreamMutex |
Global mutex to manage the access to the log-stream map. More... | |
static PredefLogStreamMap | Assimp::gPredefinedStreams |
Local storage of LogStreams allocated by aiGetPredefinedLogStream. More... | |
static aiBool | Assimp::gVerboseLogging = false |
Verbose logging active or not? More... | |
Implementation of the Plain-C API.
ASSIMP_API const aiScene* aiApplyCustomizedPostProcessing | ( | const aiScene * | scene, |
BaseProcess * | process, | ||
bool | requestValidation | ||
) |
ASSIMP_API const aiScene* aiApplyPostProcessing | ( | const aiScene * | pScene, |
unsigned int | pFlags | ||
) |
ASSIMP_API void aiAttachLogStream | ( | const aiLogStream * | stream | ) |
ASSIMP_API aiPropertyStore* aiCreatePropertyStore | ( | void | ) |
Create an empty property store.
Property stores are used to collect import settings.
ASSIMP_API void aiCreateQuaternionFromMatrix | ( | aiQuaternion * | quat, |
const aiMatrix3x3 * | mat | ||
) |
ASSIMP_API void aiDecomposeMatrix | ( | const aiMatrix4x4 * | mat, |
aiVector3D * | scaling, | ||
aiQuaternion * | rotation, | ||
aiVector3D * | position | ||
) |
ASSIMP_API void aiDetachAllLogStreams | ( | void | ) |
Detach all active log streams from the libraries' logging system.
This ensures that the logging system is terminated properly and all resources allocated by it are actually freed. If you attached a stream, don't forget to detach it again.
ASSIMP_API aiReturn aiDetachLogStream | ( | const aiLogStream * | stream | ) |
ASSIMP_API void aiEnableVerboseLogging | ( | aiBool | d | ) |
Enable verbose logging.
Verbose logging includes debug-related stuff and detailed import statistics. This can have severe impact on import performance and memory consumption. However, it might be useful to find out why a file didn't read correctly.
d | AI_TRUE or AI_FALSE, your decision. |
const char* aiGetErrorString | ( | void | ) |
Returns the error text of the last failed import process.
void aiGetExtensionList | ( | aiString * | szOut | ) |
ASSIMP_API C_STRUCT const aiImporterDesc* aiGetImporterDesc | ( | const char * | extension | ) |
Returns the Importer description for a given extension.
Will return a NULL-pointer if no assigned importer desc. was found for the given extension
extension | [in] The extension to look for |
size_t aiGetImportFormatCount | ( | void | ) |
Returns the number of import file formats available in the current Assimp build.
Use aiGetImportFormatDescription() to retrieve infos of a specific import format.
const aiImporterDesc* aiGetImportFormatDescription | ( | size_t | pIndex | ) |
Returns a description of the nth import file format.
Use aiGetImportFormatCount() to learn how many import formats are supported.
pIndex | Index of the import format to retrieve information for. Valid range is 0 to aiGetImportFormatCount() |
void aiGetMemoryRequirements | ( | const C_STRUCT aiScene * | pIn, |
C_STRUCT aiMemoryInfo * | in | ||
) |
Get the approximated storage required by an imported asset.
pIn | Input asset. |
in | Data structure to be filled. |
ASSIMP_API aiLogStream aiGetPredefinedLogStream | ( | aiDefaultLogStream | pStream, |
const char * | file | ||
) |
ASSIMP_API void aiIdentityMatrix3 | ( | aiMatrix3x3 * | mat | ) |
ASSIMP_API void aiIdentityMatrix4 | ( | aiMatrix4x4 * | mat | ) |
const aiScene* aiImportFile | ( | const char * | pFile, |
unsigned int | pFlags | ||
) |
Reads the given file and returns its content.
If the call succeeds, the imported data is returned in an aiScene structure. The data is intended to be read-only, it stays property of the ASSIMP library and will be stable until aiReleaseImport() is called. After you're done with it, call aiReleaseImport() to free the resources associated with this file. If the import fails, NULL is returned instead. Call aiGetErrorString() to retrieve a human-readable error text.
pFile | Path and filename of the file to be imported, expected to be a null-terminated c-string. NULL is not a valid value. |
pFlags | Optional post processing steps to be executed after a successful import. Provide a bitwise combination of the aiPostProcessSteps flags. |
const aiScene* aiImportFileExWithProperties | ( | const char * | pFile, |
unsigned int | pFlags, | ||
aiFileIO * | pFS, | ||
const aiPropertyStore * | props | ||
) |
const aiScene* aiImportFileFromMemory | ( | const char * | pBuffer, |
unsigned int | pLength, | ||
unsigned int | pFlags, | ||
const char * | pHint | ||
) |
Reads the given file from a given memory buffer,.
If the call succeeds, the contents of the file are returned as a pointer to an aiScene object. The returned data is intended to be read-only, the importer keeps ownership of the data and will destroy it upon destruction. If the import fails, NULL is returned. A human-readable error description can be retrieved by calling aiGetErrorString().
pBuffer | Pointer to the file data |
pLength | Length of pBuffer, in bytes |
pFlags | Optional post processing steps to be executed after a successful import. Provide a bitwise combination of the aiPostProcessSteps flags. If you wish to inspect the imported scene first in order to fine-tune your post-processing setup, consider to use aiApplyPostProcessing(). |
pHint | An additional hint to the library. If this is a non empty string, the library looks for a loader to support the file extension specified by pHint and passes the file to the first matching loader. If this loader is unable to completely the request, the library continues and tries to determine the file format on its own, a task that may or may not be successful. Check the return value, and you'll know ... |
const aiScene* aiImportFileFromMemoryWithProperties | ( | const char * | pBuffer, |
unsigned int | pLength, | ||
unsigned int | pFlags, | ||
const char * | pHint, | ||
const aiPropertyStore * | props | ||
) |
aiBool aiIsExtensionSupported | ( | const char * | szExtension | ) |
Returns whether a given file extension is supported by ASSIMP.
szExtension | Extension for which the function queries support for. Must include a leading dot '.'. Example: ".3ds", ".md3" |
ASSIMP_API void aiMultiplyMatrix3 | ( | aiMatrix3x3 * | dst, |
const aiMatrix3x3 * | src | ||
) |
ASSIMP_API void aiMultiplyMatrix4 | ( | aiMatrix4x4 * | dst, |
const aiMatrix4x4 * | src | ||
) |
void aiReleaseImport | ( | const aiScene * | pScene | ) |
ASSIMP_API void aiReleasePropertyStore | ( | aiPropertyStore * | p | ) |
ASSIMP_API void aiSetImportPropertyFloat | ( | aiPropertyStore * | p, |
const char * | szName, | ||
ai_real | value | ||
) |
ASSIMP_API void aiSetImportPropertyInteger | ( | aiPropertyStore * | p, |
const char * | szName, | ||
int | value | ||
) |
ASSIMP_API void aiSetImportPropertyMatrix | ( | aiPropertyStore * | p, |
const char * | szName, | ||
const C_STRUCT aiMatrix4x4 * | mat | ||
) |
ASSIMP_API void aiSetImportPropertyString | ( | aiPropertyStore * | p, |
const char * | szName, | ||
const C_STRUCT aiString * | st | ||
) |
ASSIMP_API void aiTransformVecByMatrix3 | ( | aiVector3D * | vec, |
const aiMatrix3x3 * | mat | ||
) |
ASSIMP_API void aiTransformVecByMatrix4 | ( | aiVector3D * | vec, |
const aiMatrix4x4 * | mat | ||
) |
ASSIMP_API void aiTransposeMatrix3 | ( | aiMatrix3x3 * | mat | ) |
ASSIMP_API void aiTransposeMatrix4 | ( | aiMatrix4x4 * | mat | ) |
void CallbackToLogRedirector | ( | const char * | msg, |
char * | dt | ||
) |
void ReportSceneNotFoundError | ( | ) |
|
static |
Global mutex to manage the access to the log-stream map.