Importer.hpp

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_HPP_INC
#define AI_ASSIMP_HPP_INC

#ifndef __cplusplus
#   error This header requires C++ to be used. Use assimp.h for plain C.
#endif // __cplusplus

// Public ASSIMP data structures
#include <assimp/types.h>

namespace Assimp    {
    // =======================================================================
    // Public interface to Assimp
    class Importer;
    class IOStream;
    class IOSystem;
    class ProgressHandler;

    // =======================================================================
    // Plugin development
    //
    // Include the following headers for the declarations:
    // BaseImporter.h
    // BaseProcess.h
    class BaseImporter;
    class BaseProcess;
    class SharedPostProcessInfo;
    class BatchLoader;

    // =======================================================================
    // Holy stuff, only for members of the high council of the Jedi.
    class ImporterPimpl;
} 

#define AI_PROPERTY_WAS_NOT_EXISTING 0xffffffff

struct aiScene;

// importerdesc.h
struct aiImporterDesc;

namespace Assimp    {

// ----------------------------------------------------------------------------------
class ASSIMP_API Importer   {
public:
    static const unsigned int MaxLenHint = 200;

public:

    // -------------------------------------------------------------------
    Importer();

    // -------------------------------------------------------------------
    Importer(const Importer& other);

    // -------------------------------------------------------------------
    ~Importer();


    // -------------------------------------------------------------------
    aiReturn RegisterLoader(BaseImporter* pImp);

    // -------------------------------------------------------------------
    aiReturn UnregisterLoader(BaseImporter* pImp);

    // -------------------------------------------------------------------
    aiReturn RegisterPPStep(BaseProcess* pImp);

    // -------------------------------------------------------------------
    aiReturn UnregisterPPStep(BaseProcess* pImp);

    // -------------------------------------------------------------------
    bool SetPropertyInteger(const char* szName, int iValue);

    // -------------------------------------------------------------------
    bool SetPropertyBool(const char* szName, bool value)    {
        return SetPropertyInteger(szName,value);
    }

    // -------------------------------------------------------------------
    bool SetPropertyFloat(const char* szName, ai_real fValue);

    // -------------------------------------------------------------------
    bool SetPropertyString(const char* szName, const std::string& sValue);

    // -------------------------------------------------------------------
    bool SetPropertyMatrix(const char* szName, const aiMatrix4x4& sValue);

    // -------------------------------------------------------------------
    int GetPropertyInteger(const char* szName,
        int iErrorReturn = 0xffffffff) const;

    // -------------------------------------------------------------------
    bool GetPropertyBool(const char* szName, bool bErrorReturn = false) const {
        return GetPropertyInteger(szName,bErrorReturn)!=0;
    }

    // -------------------------------------------------------------------
    ai_real GetPropertyFloat(const char* szName,
        ai_real fErrorReturn = 10e10) const;

    // -------------------------------------------------------------------
    const std::string GetPropertyString(const char* szName,
        const std::string& sErrorReturn = "") const;

    // -------------------------------------------------------------------
    const aiMatrix4x4 GetPropertyMatrix(const char* szName,
        const aiMatrix4x4& sErrorReturn = aiMatrix4x4()) const;

    // -------------------------------------------------------------------
    void SetIOHandler( IOSystem* pIOHandler);

    // -------------------------------------------------------------------
    IOSystem* GetIOHandler() const;

    // -------------------------------------------------------------------
    bool IsDefaultIOHandler() const;

    // -------------------------------------------------------------------
    void SetProgressHandler ( ProgressHandler* pHandler );

    // -------------------------------------------------------------------
    ProgressHandler* GetProgressHandler() const;

    // -------------------------------------------------------------------
    bool IsDefaultProgressHandler() const;

    // -------------------------------------------------------------------
    bool ValidateFlags(unsigned int pFlags) const;

    // -------------------------------------------------------------------
    const aiScene* ReadFile(
        const char* pFile,
        unsigned int pFlags);

    // -------------------------------------------------------------------
    const aiScene* ReadFileFromMemory(
        const void* pBuffer,
        size_t pLength,
        unsigned int pFlags,
        const char* pHint = "");

    // -------------------------------------------------------------------
    const aiScene* ApplyPostProcessing(unsigned int pFlags);

    const aiScene* ApplyCustomizedPostProcessing( BaseProcess *rootProcess, bool requestValidation );

    // -------------------------------------------------------------------
    const aiScene* ReadFile(
        const std::string& pFile,
        unsigned int pFlags);

    // -------------------------------------------------------------------
    void FreeScene( );

    // -------------------------------------------------------------------
    const char* GetErrorString() const;

    // -------------------------------------------------------------------
    const aiScene* GetScene() const;

    // -------------------------------------------------------------------
    aiScene* GetOrphanedScene();

    // -------------------------------------------------------------------
    bool IsExtensionSupported(const char* szExtension) const;

    // -------------------------------------------------------------------
    inline bool IsExtensionSupported(const std::string& szExtension) const;

    // -------------------------------------------------------------------
    void GetExtensionList(aiString& szOut) const;

    // -------------------------------------------------------------------
    inline void GetExtensionList(std::string& szOut) const;

    // -------------------------------------------------------------------
    size_t GetImporterCount() const;

    // -------------------------------------------------------------------
    const aiImporterDesc* GetImporterInfo(size_t index) const;

    // -------------------------------------------------------------------
    BaseImporter* GetImporter(size_t index) const;

    // -------------------------------------------------------------------
    BaseImporter* GetImporter (const char* szExtension) const;

    // -------------------------------------------------------------------
    size_t GetImporterIndex (const char* szExtension) const;

    // -------------------------------------------------------------------
    void GetMemoryRequirements(aiMemoryInfo& in) const;

    // -------------------------------------------------------------------
    void SetExtraVerbose(bool bDo);

    // -------------------------------------------------------------------
    ImporterPimpl* Pimpl() { return pimpl; }
    const ImporterPimpl* Pimpl() const { return pimpl; }

protected:

    // Just because we don't want you to know how we're hacking around.
    ImporterPimpl* pimpl;
}; 


// ----------------------------------------------------------------------------
// For compatibility, the interface of some functions taking a std::string was
// changed to const char* to avoid crashes between binary incompatible STL
// versions. This code her is inlined,  so it shouldn't cause any problems.
// ----------------------------------------------------------------------------

// ----------------------------------------------------------------------------
AI_FORCE_INLINE const aiScene* Importer::ReadFile( const std::string& pFile,unsigned int pFlags){
    return ReadFile(pFile.c_str(),pFlags);
}
// ----------------------------------------------------------------------------
AI_FORCE_INLINE void Importer::GetExtensionList(std::string& szOut) const   {
    aiString s;
    GetExtensionList(s);
    szOut = s.data;
}
// ----------------------------------------------------------------------------
AI_FORCE_INLINE bool Importer::IsExtensionSupported(const std::string& szExtension) const   {
    return IsExtensionSupported(szExtension.c_str());
}

} // !namespace Assimp

#endif // AI_ASSIMP_HPP_INC