cimport.h

Go to the documentation of this file.

/*
---------------------------------------------------------------------------
Open Asset Import Library (assimp)
---------------------------------------------------------------------------

Copyright (c) 2006-2017, assimp team


All rights reserved.

Redistribution and use of this software in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.

* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.

* Neither the name of the assimp team, nor the names of its
  contributors may be used to endorse or promote products
  derived from this software without specific prior
  written permission of the assimp team.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
---------------------------------------------------------------------------
*/

#pragma once
#ifndef AI_ASSIMP_H_INC
#define AI_ASSIMP_H_INC

#include <assimp/types.h>
#include "importerdesc.h"

#ifdef __cplusplus
extern "C" {
#endif

struct aiScene;  // aiScene.h
struct aiFileIO; // aiFileIO.h
typedef void (*aiLogStreamCallback)(const char* /* message */, char* /* user */);

// --------------------------------------------------------------------------------
// --------------------------------------------------------------------------------
struct aiLogStream
{
    aiLogStreamCallback callback;

    char* user;
};


// --------------------------------------------------------------------------------
// --------------------------------------------------------------------------------
struct aiPropertyStore { char sentinel; };

typedef int aiBool;

#define AI_FALSE 0
#define AI_TRUE 1

// --------------------------------------------------------------------------------
ASSIMP_API const C_STRUCT aiScene* aiImportFile(
    const char* pFile,
    unsigned int pFlags);

// --------------------------------------------------------------------------------
ASSIMP_API const C_STRUCT aiScene* aiImportFileEx(
    const char* pFile,
    unsigned int pFlags,
    C_STRUCT aiFileIO* pFS);

// --------------------------------------------------------------------------------
ASSIMP_API const C_STRUCT aiScene* aiImportFileExWithProperties(
    const char* pFile,
    unsigned int pFlags,
    C_STRUCT aiFileIO* pFS,
    const C_STRUCT aiPropertyStore* pProps);

// --------------------------------------------------------------------------------
ASSIMP_API const C_STRUCT aiScene* aiImportFileFromMemory(
    const char* pBuffer,
    unsigned int pLength,
    unsigned int pFlags,
    const char* pHint);

// --------------------------------------------------------------------------------
ASSIMP_API const C_STRUCT aiScene* aiImportFileFromMemoryWithProperties(
    const char* pBuffer,
    unsigned int pLength,
    unsigned int pFlags,
    const char* pHint,
    const C_STRUCT aiPropertyStore* pProps);

// --------------------------------------------------------------------------------
ASSIMP_API const C_STRUCT aiScene* aiApplyPostProcessing(
    const C_STRUCT aiScene* pScene,
    unsigned int pFlags);

// --------------------------------------------------------------------------------
ASSIMP_API C_STRUCT aiLogStream aiGetPredefinedLogStream(
    C_ENUM aiDefaultLogStream pStreams,
    const char* file);

// --------------------------------------------------------------------------------
ASSIMP_API void aiAttachLogStream(
    const C_STRUCT aiLogStream* stream);

// --------------------------------------------------------------------------------
ASSIMP_API void aiEnableVerboseLogging(aiBool d);

// --------------------------------------------------------------------------------
ASSIMP_API C_ENUM aiReturn aiDetachLogStream(
    const C_STRUCT aiLogStream* stream);

// --------------------------------------------------------------------------------
ASSIMP_API void aiDetachAllLogStreams(void);

// --------------------------------------------------------------------------------
ASSIMP_API void aiReleaseImport(
    const C_STRUCT aiScene* pScene);

// --------------------------------------------------------------------------------
ASSIMP_API const char* aiGetErrorString(void);

// --------------------------------------------------------------------------------
ASSIMP_API aiBool aiIsExtensionSupported(
    const char* szExtension);

// --------------------------------------------------------------------------------
ASSIMP_API void aiGetExtensionList(
    C_STRUCT aiString* szOut);

// --------------------------------------------------------------------------------
ASSIMP_API void aiGetMemoryRequirements(
    const C_STRUCT aiScene* pIn,
    C_STRUCT aiMemoryInfo* in);



// --------------------------------------------------------------------------------
ASSIMP_API C_STRUCT aiPropertyStore* aiCreatePropertyStore(void);

// --------------------------------------------------------------------------------
ASSIMP_API void aiReleasePropertyStore(C_STRUCT aiPropertyStore* p);

// --------------------------------------------------------------------------------
ASSIMP_API void aiSetImportPropertyInteger(
    C_STRUCT aiPropertyStore* store,
    const char* szName,
    int value);

// --------------------------------------------------------------------------------
ASSIMP_API void aiSetImportPropertyFloat(
    C_STRUCT aiPropertyStore* store,
    const char* szName,
    ai_real value);

// --------------------------------------------------------------------------------
ASSIMP_API void aiSetImportPropertyString(
    C_STRUCT aiPropertyStore* store,
    const char* szName,
    const C_STRUCT aiString* st);

// --------------------------------------------------------------------------------
ASSIMP_API void aiSetImportPropertyMatrix(
    C_STRUCT aiPropertyStore* store,
    const char* szName,
    const C_STRUCT aiMatrix4x4* mat);

// --------------------------------------------------------------------------------
ASSIMP_API void aiCreateQuaternionFromMatrix(
    C_STRUCT aiQuaternion* quat,
    const C_STRUCT aiMatrix3x3* mat);

// --------------------------------------------------------------------------------
ASSIMP_API void aiDecomposeMatrix(
    const C_STRUCT aiMatrix4x4* mat,
    C_STRUCT aiVector3D* scaling,
    C_STRUCT aiQuaternion* rotation,
    C_STRUCT aiVector3D* position);

// --------------------------------------------------------------------------------
ASSIMP_API void aiTransposeMatrix4(
    C_STRUCT aiMatrix4x4* mat);

// --------------------------------------------------------------------------------
ASSIMP_API void aiTransposeMatrix3(
    C_STRUCT aiMatrix3x3* mat);

// --------------------------------------------------------------------------------
ASSIMP_API void aiTransformVecByMatrix3(
    C_STRUCT aiVector3D* vec,
    const C_STRUCT aiMatrix3x3* mat);

// --------------------------------------------------------------------------------
ASSIMP_API void aiTransformVecByMatrix4(
    C_STRUCT aiVector3D* vec,
    const C_STRUCT aiMatrix4x4* mat);

// --------------------------------------------------------------------------------
ASSIMP_API void aiMultiplyMatrix4(
    C_STRUCT aiMatrix4x4* dst,
    const C_STRUCT aiMatrix4x4* src);

// --------------------------------------------------------------------------------
ASSIMP_API void aiMultiplyMatrix3(
    C_STRUCT aiMatrix3x3* dst,
    const C_STRUCT aiMatrix3x3* src);

// --------------------------------------------------------------------------------
ASSIMP_API void aiIdentityMatrix3(
    C_STRUCT aiMatrix3x3* mat);

// --------------------------------------------------------------------------------
ASSIMP_API void aiIdentityMatrix4(
    C_STRUCT aiMatrix4x4* mat);

// --------------------------------------------------------------------------------
ASSIMP_API size_t aiGetImportFormatCount(void);

// --------------------------------------------------------------------------------
ASSIMP_API const C_STRUCT aiImporterDesc* aiGetImportFormatDescription( size_t pIndex);
#ifdef __cplusplus
}
#endif

#endif // AI_ASSIMP_H_INC