kfbxreader.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_KFBXIO_KFBXREADER_H
#define FBXFILESDK_KFBXIO_KFBXREADER_H


#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/components/kbaselib/klib/kerror.h>
#include <fbxfilesdk/components/kbaselib/kfbx/kfbx.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxDocument;
class KFbxDocumentInfo;
class KFbxNode;
class KFbxSdkManager;
class KFbxImporter;
class KFbxIOSettings;
class KFbxAxisSystem;
class KFbxSystemUnit;
class KFbxStatistics;
class KFbxTakeInfo;
class KFile;
class KFbxObject;
class KFbxScene;
class KFbxProgress;

class KFBX_DLL KFbxReader
{
public:
    KFbxReader(KFbxSdkManager& pManager, int pID);

    virtual ~KFbxReader();
    
    typedef enum
    {
        eFILE_CORRUPTED,
        eFILE_VERSION_NOT_SUPPORTED_YET,
        eFILE_VERSION_NOT_SUPPORTED_ANYMORE,
        eFILE_NOT_OPENED,
        eFILE_NOT_CREATED,
        eWRONG_PASSWORD,
        eINVALID_DOCUMENT_HANDLE,
        eDOCUMENT_NOT_SUPPORTED,
        eUNRESOLVED_EXTERNAL_REFERENCES,
        eUNIDENTIFIED_ERROR,
        eERROR_COUNT
    } EError;

    enum KInfoRequest {
        eInfoExtension,     
        eInfoDescriptions,  
        eReserved1 = 0xFBFB,
    };

    enum EFileOpenSpecialFlags {
        ParseForGlobalSettings = 1, 
        ParseForStatistics = 2      
    };

    typedef KFbxReader*         (*CreateFuncType)(KFbxSdkManager& pManager, KFbxImporter& pImporter, int pSubID, int pPluginID);

    typedef void                (*IOSettingsFillerFuncType)(KFbxIOSettings& pIOS);

    typedef void*               (*GetInfoFuncType)(KInfoRequest pRequest, int pReaderTypeId);

    virtual void                GetVersion(int& pMajor, int& pMinor, int& pRevision){ pMajor = pMinor = pRevision = 0; }

    virtual bool                FileOpen(char* pFileName) = 0;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    virtual bool                FileOpen(KFile * pFile);
#endif 

    virtual bool                FileClose() = 0;

    virtual bool                IsFileOpen() = 0;

    virtual bool                GetReadOptions(bool pParseFileAsNeeded = true) = 0;

    virtual bool                Read(KFbxDocument* pDocument) = 0;

    virtual void                PluginReadParameters(KFbxObject& pParams);

    virtual bool                FileOpen(char* pFileName, EFileOpenSpecialFlags pFlags){ return FileOpen(pFileName); }

    virtual bool                GetAxisInfo(KFbxAxisSystem* pAxisSystem, KFbxSystemUnit* pSystemUnits){ return false; }

    virtual bool                GetStatistics(KFbxStatistics* pStats){ return false; }

    virtual bool                GetFrameRate(KTime::ETimeMode &pTimeMode) { pTimeMode = KTime::eDEFAULT_MODE; return false; }


    virtual KFbxDocumentInfo*   GetSceneInfo(){return NULL;}

    virtual KArrayTemplate<KFbxTakeInfo*>* GetTakeInfo(){return NULL;}

    virtual bool                GetDefaultRenderResolution(KString& pCamName, KString& pResolutionMode, double& pW, double& pH);

    bool                        IsGenuine();

    KError&                     GetError();

    EError                      GetLastErrorID() const;

    const char*                 GetLastErrorString() const;

    void                        GetMessage(KString& pMessage) const;

    KString&                    GetMessage();

    void                        ClearMessage();

    virtual KFbxIOSettings * GetIOSettings();

    virtual void SetIOSettings(KFbxIOSettings * pIOSettings);

    virtual void SetProgressHandler(KFbxProgress *pProgress){}

    virtual void SetEmbeddingExtractionFolder(const char* pExtractFolder){}

protected:
    void                        SetDefaultRenderResolution(const char* pCamName, const char* pResolutionMode, double pW, double pH);
    
    void                        PluginsReadBegin(KFbxScene& pScene);
    void                        PluginsRead(const char* pName, const char* pVersion);
    void                        PluginsReadEnd(KFbxScene& pScene);

    KFbxReader&                 operator=(KFbxReader const&) { return *this; }
    virtual bool                CheckDuplicateNodeNames(KFbxNode* pRootNode, KString& pDuplicateNodeNameList);

    KFbxSdkManager&             mManager;
    KDefaultRenderResolution*   mData;

private:
    KError                      mError;
    KString                     mMessage;
    int                         mInternalID;
    KFbxIOSettings *            mIOSettings;

    friend struct KFbxReaderFbx7Impl;
};

#define IOS_REF (*GetIOSettings())

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXIO_KFBXREADER_H