fbxreader.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2019 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/fbxarray.h>
#include <fbxsdk/core/base/fbxstring.h>
#include <fbxsdk/core/base/fbxtime.h>
#include <fbxsdk/fileio/fbx/fbxio.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

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

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

    virtual ~FbxReader();
    
    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;

    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;

#ifndef FBXSDK_ENV_WINSTORE

    virtual void                PluginReadParameters(FbxObject& pParams);
#endif /* !FBXSDK_ENV_WINSTORE */

    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();
   
    virtual FbxIOSettings * GetIOSettings();

    virtual void SetIOSettings(FbxIOSettings * pIOSettings);

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

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

    virtual void SetEmbeddedFileCallback(FbxEmbeddedFileCallback* /*pCallback*/) {}

    virtual bool SupportsStreams() const;

/*****************************************************************************************************************************
** 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
    virtual bool                FileOpen(FbxFile * pFile);

    FbxStatus& GetStatus()              { return mStatus; }

protected:
    void                        SetDefaultRenderResolution(const char* pCamName, const char* pResolutionMode, double pW, double pH);
#ifndef FBXSDK_ENV_WINSTORE
    void                        PluginsReadBegin(FbxScene& pScene);
    void                        PluginsRead(const char* pName, const char* pVersion);
    void                        PluginsReadEnd(FbxScene& pScene);
#endif /* !FBXSDK_ENV_WINSTORE */
    FbxReader&                  operator=(FbxReader const&) { return *this; }
    virtual bool                CheckDuplicateNodeNames(FbxNode* pRootNode, FbxString& pDuplicateNodeNameList);

    FbxStatus&                      mStatus;
    FbxManager&                     mManager;
    FbxIODefaultRenderResolution*   mData;

private:
    int             mInternalID;
    FbxIOSettings*  mIOSettings;

    friend struct FbxReaderFbx7_Impl;
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

#define IOS_REF (*GetIOSettings())

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_READER_H_ */