fbxiopluginregistry.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2015 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_FILEIO_IO_PLUGIN_REGISTRY_H_
#define _FBXSDK_FILEIO_IO_PLUGIN_REGISTRY_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/fileio/fbxreader.h>
#include <fbxsdk/fileio/fbxwriter.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FBXSDK_DLL FbxIOPluginRegistry
{
public:

    FbxIOPluginRegistry();

    virtual ~FbxIOPluginRegistry();

#ifndef FBXSDK_ENV_WINSTORE

    void RegisterReader(const char* pPluginPath,
                        int& pFirstPluginID,
                        int& pRegisteredCount,
                        bool pOverride = false);
#endif /* !FBXSDK_ENV_WINSTORE */

    void RegisterReader(FbxReader::CreateFuncType pCreateF, 
                        FbxReader::GetInfoFuncType pInfoF,
                        int& pFirstPluginID,
                        int& pRegisteredCount,
                        FbxReader::IOSettingsFillerFuncType pIOSettingsFillerF = NULL,
                        bool pOverride = false);

#ifndef FBXSDK_ENV_WINSTORE

    void RegisterWriter(const char* pPluginPath,
                        int& pFirstPluginID,
                        int& pRegisteredCount,
                        bool pOverride = false);
#endif /* !FBXSDK_ENV_WINSTORE */

    void RegisterWriter(FbxWriter::CreateFuncType pCreateF, 
                        FbxWriter::GetInfoFuncType pInfoF,
                        int& pFirstPluginID,
                        int& pRegisteredCount,
                        FbxWriter::IOSettingsFillerFuncType pIOSettingsFillerF = NULL,
                        bool pOverride = false);

    FbxReader* CreateReader(FbxManager& pManager, 
                             FbxImporter& pImporter, 
                             int pPluginID) const;

    FbxWriter* CreateWriter(FbxManager& pManager, 
                             FbxExporter& pExporter,
                             int pPluginID) const;

    int FindReaderIDByExtension(const char* pExt) const;

    int FindWriterIDByExtension(const char* pExt) const;
    
    int FindReaderIDByDescription(const char* pDesc) const;

    int FindWriterIDByDescription(const char* pDesc) const;
    
    bool ReaderIsFBX(int pFileFormat) const;

    bool WriterIsFBX(int pFileFormat) const;

    bool ReaderIsGenuine(int pFileFormat) const;

    bool WriterIsGenuine(int pFileFormat) const;

    int GetReaderFormatCount() const;

    int GetWriterFormatCount() const;

    const char* GetReaderFormatDescription(int pFileFormat) const;

    const char* GetWriterFormatDescription(int pFileFormat) const;

    const char* GetReaderFormatExtension(int pFileFormat) const;
    
    const char* GetWriterFormatExtension(int pFileFormat) const;

    char const* const* GetWritableVersions(int pFileFormat) const;

    bool DetectReaderFileFormat(const char* pFileName, int& pFileFormat) const;

    bool DetectWriterFileFormat(const char* pFileName, int& pFileFormat) const;
    
    int GetNativeReaderFormat();

    int GetNativeWriterFormat();

    void FillIOSettingsForReadersRegistered(FbxIOSettings & pIOS);

    void FillIOSettingsForWritersRegistered(FbxIOSettings & pIOS);


/*****************************************************************************************************************************
** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
*****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    void RegisterInternalIOPlugins();

    struct ReaderPluginEntry
    {
        ReaderPluginEntry(const char* pExtension, const char* pDescription, FbxReader::CreateFuncType pCreatorFunction, int pBaseID,
            FbxReader::IOSettingsFillerFuncType pIOSettingsFillerFunction=NULL);
        
        const char*                             mExtension;
        const char*                             mDescription;
        FbxReader::CreateFuncType               mCreatorFunction;
        FbxReader::IOSettingsFillerFuncType mIOSettingsFillerFunction;
        int                                     mBaseID;
        bool                                    mIsFBX;
        bool                                    mIsInternalPlugin;
    };
    
    struct WriterPluginEntry
    {
        WriterPluginEntry(const char* pExtension, const char* pDescription, char const* const* pVersions, FbxWriter::CreateFuncType pCreatorFunction, int pBaseID,
            FbxWriter::IOSettingsFillerFuncType pIOSettingsFillerFunction=NULL);
        
        const char*                             mExtension;
        const char*                             mDescription;
        char const* const*                      mVersions;
        FbxWriter::CreateFuncType               mCreatorFunction;
        FbxWriter::IOSettingsFillerFuncType mIOSettingsFillerFunction;
        int                                     mBaseID;
        bool                                    mIsFBX;
        bool                                    mIsInternalPlugin;
    };

    FbxArray<ReaderPluginEntry*>    mReaders;
    FbxArray<WriterPluginEntry*>    mWriters;
    int                                 mNativeReaderFormat;
    int                                 mNativeWriterFormat;
    bool                                mInternalPluginMode;
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_IO_PLUGIN_REGISTRY_H_ */