fbxreader.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 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_READER_H_
#define _FBXSDK_FILEIO_READER_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxerror.h>
#include <fbxsdk/fileio/fbx/fbxio.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxDocument;
class FbxDocumentInfo;
class FbxNode;
class FbxManager;
class FbxImporter;
class FbxIOSettings;
class FbxAxisSystem;
class FbxSystemUnit;
class FbxStatistics;
class FbxTakeInfo;
class FbxFile;
class FbxObject;
class FbxScene;
class FbxProgress;
class FbxStream;

class FBXSDK_DLL FbxReader
{
public:
    FbxReader(FbxManager& pManager, int pID);

    virtual ~FbxReader();
    
    enum EErrorCode
    {
        eFileCorrupted,
        eFileVersionNotSupportedYet,
        eFileVersionNotSupportedAnymore,
        eFileNotOpened,
        eFileNotCreated,
        eWrongPassword,
        eInvalidDocumentHandle,
        eDocumentNotSupported,
        eUnresolvedExternalReferences,
        eUnknownError,
        eErrorCount
    };

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

    enum EFileOpenSpecialFlags
    {
        eParseForGlobalSettings = 1, 
        eParseForStatistics = 2      
    };

    typedef FbxReader*          (*CreateFuncType)(FbxManager& pManager, FbxImporter& pImporter, int pSubID, int pPluginID);

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

    typedef void*               (*GetInfoFuncType)(EInfoRequest 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(FbxFile * pFile);
#endif 

    virtual bool                FileOpen(FbxStream* pStream, void* pStreamData);

    virtual bool                FileClose() = 0;

    virtual bool                IsFileOpen() = 0;

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

    virtual bool                Read(FbxDocument* pDocument) = 0;

    virtual void                PluginReadParameters(FbxObject& pParams);

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

    virtual bool                GetAxisInfo(FbxAxisSystem* /*pAxisSystem*/, FbxSystemUnit* /*pSystemUnits*/){ return false; }

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

    virtual bool                GetFrameRate(FbxTime::EMode& pTimeMode) { pTimeMode = FbxTime::eDefaultMode; return false; }


    virtual FbxDocumentInfo*   GetSceneInfo(){return NULL;}

    virtual FbxArray<FbxTakeInfo*>* GetTakeInfo(){return NULL;}

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

    bool                        IsGenuine();

    FbxError&                       GetError();

    EErrorCode                      GetLastErrorID() const;

    const char*                 GetLastErrorString() const;

    void                        GetMessage(FbxString& pMessage) const;

    FbxString&                  GetMessage();

    void                        ClearMessage();

    virtual FbxIOSettings * GetIOSettings();

    virtual void SetIOSettings(FbxIOSettings * pIOSettings);

    virtual void SetProgressHandler(FbxProgress* /*pProgress*/){}

    virtual void SetEmbeddingExtractionFolder(const char* /*pExtractFolder*/){}

    virtual bool SupportsStreams() const;

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

    FbxReader&                  operator=(FbxReader const&) { return *this; }
    virtual bool                CheckDuplicateNodeNames(FbxNode* pRootNode, FbxString& pDuplicateNodeNameList);

    FbxManager&             mManager;
    FbxIODefaultRenderResolution*   mData;

private:
    FbxError                        mError;
    FbxString                       mMessage;
    int                         mInternalID;
    FbxIOSettings *            mIOSettings;

    friend struct FbxReaderFbx7_Impl;
};

#define IOS_REF (*GetIOSettings())

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_READER_H_ */