Exporter.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_EXPORT_HPP_INC
#define AI_EXPORT_HPP_INC

#ifndef ASSIMP_BUILD_NO_EXPORT

#include "cexport.h"
#include <map>

namespace Assimp {
    
class ExporterPimpl;
class IOSystem;

// ----------------------------------------------------------------------------------
class ASSIMP_API ExportProperties;

class ASSIMP_API Exporter {
public:
    typedef void (*fpExportFunc)(const char*, IOSystem*, const aiScene*, const ExportProperties*);

    struct ExportFormatEntry
    {
        aiExportFormatDesc mDescription;

        // Worker function to do the actual exporting
        fpExportFunc mExportFunction;

        // Post-processing steps to be executed PRIOR to invoking mExportFunction
        unsigned int mEnforcePP;

        // Constructor to fill all entries
        ExportFormatEntry( const char* pId, const char* pDesc, const char* pExtension, fpExportFunc pFunction, unsigned int pEnforcePP = 0u)
        {
            mDescription.id = pId;
            mDescription.description = pDesc;
            mDescription.fileExtension = pExtension;
            mExportFunction = pFunction;
            mEnforcePP = pEnforcePP;
        }

        ExportFormatEntry() :
            mExportFunction()
          , mEnforcePP()
        {
            mDescription.id = NULL;
            mDescription.description = NULL;
            mDescription.fileExtension = NULL;
        }
    };


public:
    Exporter();
    ~Exporter();

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

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

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

    // -------------------------------------------------------------------
    const aiExportDataBlob* ExportToBlob(const aiScene* pScene, const char* pFormatId, unsigned int pPreprocessing = 0u, const ExportProperties* = NULL);
    const aiExportDataBlob* ExportToBlob(  const aiScene* pScene, const std::string& pFormatId, unsigned int pPreprocessing = 0u, const ExportProperties* pProperties = NULL);

    // -------------------------------------------------------------------
    aiReturn Export( const aiScene* pScene, const char* pFormatId, const char* pPath, unsigned int pPreprocessing = 0u, const ExportProperties* pProperties = NULL);
    aiReturn Export( const aiScene* pScene, const std::string& pFormatId, const std::string& pPath,  unsigned int pPreprocessing = 0u, const ExportProperties* pProperties = NULL);

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

    // -------------------------------------------------------------------
    const aiExportDataBlob* GetBlob() const;

    // -------------------------------------------------------------------
    const aiExportDataBlob* GetOrphanedBlob() const;

    // -------------------------------------------------------------------
    void FreeBlob( );

    // -------------------------------------------------------------------
    size_t GetExportFormatCount() const;

    // -------------------------------------------------------------------
    const aiExportFormatDesc* GetExportFormatDescription( size_t pIndex ) const;

    // -------------------------------------------------------------------
    aiReturn RegisterExporter(const ExportFormatEntry& desc);

    // -------------------------------------------------------------------
    void UnregisterExporter(const char* id);

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

class ASSIMP_API ExportProperties {
public:
    // Data type to store the key hash
    typedef unsigned int KeyType;

    // typedefs for our four configuration maps.
    // We don't need more, so there is no need for a generic solution
    typedef std::map<KeyType, int> IntPropertyMap;
    typedef std::map<KeyType, ai_real> FloatPropertyMap;
    typedef std::map<KeyType, std::string> StringPropertyMap;
    typedef std::map<KeyType, aiMatrix4x4> MatrixPropertyMap;

public:
    ExportProperties();

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

    // -------------------------------------------------------------------
    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 = 10e10f) const;

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

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

    // -------------------------------------------------------------------
    bool HasPropertyInteger(const char* szName) const;

    bool HasPropertyBool(const char* szName) const;

    bool HasPropertyFloat(const char* szName) const;

    bool HasPropertyString(const char* szName) const;

    bool HasPropertyMatrix(const char* szName) const;

protected:

    IntPropertyMap mIntProperties;

    FloatPropertyMap mFloatProperties;

    StringPropertyMap mStringProperties;

    MatrixPropertyMap mMatrixProperties;
};

// ----------------------------------------------------------------------------------
inline 
const aiExportDataBlob* Exporter::ExportToBlob(  const aiScene* pScene, const std::string& pFormatId,
                                                 unsigned int pPreprocessing, const ExportProperties* pProperties)
{
    return ExportToBlob(pScene,pFormatId.c_str(),pPreprocessing, pProperties);
}

// ----------------------------------------------------------------------------------
inline
aiReturn Exporter :: Export( const aiScene* pScene, const std::string& pFormatId, 
                                    const std::string& pPath, unsigned int pPreprocessing, 
                                    const ExportProperties* pProperties)
{
    return Export(pScene,pFormatId.c_str(),pPath.c_str(),pPreprocessing, pProperties);
}

} // namespace Assimp

#endif // ASSIMP_BUILD_NO_EXPORT
#endif // AI_EXPORT_HPP_INC