kfbxiopluginregistry.h

Go to the documentation of this file.

/****************************************************************************************

   Copyright (C) 2010 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 FBXFILESDK_KFBXPLUGINS_KFBXIOPLUGINREGISTRY_H
#define FBXFILESDK_KFBXPLUGINS_KFBXIOPLUGINREGISTRY_H


#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/kfbxio/kfbxreader.h>
#include <fbxfilesdk/kfbxio/kfbxwriter.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxSdkManager;
class KFbxIOPluginRegistry;
class KFbxExporter;
class KFbxImporter;
class KFbxIOSettings;

class KFBX_DLL KFbxIOPluginRegistry
{
public:

    KFbxIOPluginRegistry();

    virtual ~KFbxIOPluginRegistry();

    void RegisterReader(char const* pPluginPath,
                        int& pFirstPluginID,
                        int& pRegisteredCount);

    void RegisterReader(KFbxReader::CreateFuncType pCreateF, 
                        KFbxReader::GetInfoFuncType pInfoF,
                        int& pFirstPluginID,
                        int& pRegisteredCount,
                        KFbxReader::IOSettingsFillerFuncType pIOSettingsFillerF = NULL
                       );


    void RegisterWriter(char const* pPluginPath,
                        int& pFirstPluginID,
                        int& pRegisteredCount);

    void RegisterWriter(KFbxWriter::CreateFuncType pCreateF, 
                        KFbxWriter::GetInfoFuncType pInfoF,
                        int& pFirstPluginID,
                        int& pRegisteredCount,
                        KFbxWriter::IOSettingsFillerFuncType pIOSettingsFillerF = NULL);

    KFbxReader* CreateReader(KFbxSdkManager& pManager, 
                             KFbxImporter& pImporter, 
                             int pPluginID) const;

    KFbxWriter* CreateWriter(KFbxSdkManager& pManager, 
                             KFbxExporter& pExporter,
                             int pPluginID) const;

    int FindReaderIDByExtension(char const* pExt) const;

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

    int FindWriterIDByDescription(char const* 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;

    char const* GetReaderFormatDescription(int pFileFormat) const;

    char const* GetWriterFormatDescription(int pFileFormat) const;

    char const* GetReaderFormatExtension(int pFileFormat) const;
    
    char const* 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(KFbxIOSettings & pIOS);

    void FillIOSettingsForWritersRegistered(KFbxIOSettings & pIOS);


//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:
    void RegisterInternalIOPlugins();

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

    KArrayTemplate<ReaderPluginEntry*>  mReaders;
    KArrayTemplate<WriterPluginEntry*>  mWriters;
    int                                 mNativeReaderFormat;
    int                                 mNativeWriterFormat;
    bool                                mInternalPluginMode;

#endif //DOXYGEN
};


#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXIOPLUGINREGISTRY_H