fbxsdk/fileio/fbximporter.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2013 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_IMPORTER_H_
#define _FBXSDK_FILEIO_IMPORTER_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxsystemunit.h>
#include <fbxsdk/core/base/fbxtime.h>
#include <fbxsdk/fileio/fbxiobase.h>
#include <fbxsdk/fileio/fbxprogress.h>
#include <fbxsdk/fileio/fbxiosettings.h>
#include <fbxsdk/fileio/fbxstatistics.h>
#include <fbxsdk/scene/fbxaxissystem.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxIO;
class FbxIOFileHeaderInfo;
class FbxDocumentInfo;
class FbxTakeInfo;
class FbxReader;
class FbxThread;

struct FbxImportThreadArg;

class FBXSDK_DLL FbxImporter : public FbxIOBase
{
        FBXSDK_OBJECT_DECLARE(FbxImporter, FbxIOBase);

public:

        virtual bool Initialize(const char* pFileName, const int pFileFormat=-1, FbxIOSettings * pIOSettings=NULL);

        virtual bool Initialize(FbxStream* pStream, void* pStreamData=NULL, const int pFileFormat=-1, FbxIOSettings* pIOSettings=NULL);

        void GetFileVersion(int& pMajor, int& pMinor, int& pRevision);

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

        FbxIOFileHeaderInfo* GetFileHeaderInfo();

        enum EStreamOptionsGeneration
        {
                eParseFile,             // Parse the file
                eDoNotParseFile // Do not parse the file (fast)
        };

          bool GetImportOptions(EStreamOptionsGeneration pStreamOptionsGeneration = eParseFile);        

          bool GetImportOptions(FbxIO* pFbxObject);

          bool Import(FbxDocument* pDocument, bool pNonBlocking=false);

#ifndef FBXSDK_ENV_WINRT

          bool IsImporting(bool& pImportResult);
#endif /* !FBXSDK_ENV_WINRT */

      float GetProgress(FbxString* pStatus=NULL);

      void SetProgressCallback(FbxProgressCallback pCallback, void* pArgs=NULL);

        void SetEmbeddingExtractionFolder(const char* pExtractFolder);

        const char* GetEmbeddingExtractionFolder();

          FbxIOSettings* GetIOSettings();

          void SetIOSettings(FbxIOSettings* pIOSettings);

      void SetPassword(char* pPassword);

        
      int GetAnimStackCount();

          FbxTakeInfo* GetTakeInfo(int pIndex);

      FbxString GetActiveAnimStackName();



        FbxDocumentInfo* GetSceneInfo();



        int GetFileFormat ();

        bool IsFBX();

/*****************************************************************************************************************************
** 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
        FbxFile* GetFile();
    FbxStream* GetStream();
    void*      GetStreamData();

        void ParseForGlobalSettings(bool pState);
    void ParseForStatistics(bool pState);
        bool GetAxisInfo(FbxAxisSystem* pAxisSystem, FbxSystemUnit* pSystemUnits);
    bool GetStatistics(FbxStatistics* pStatistics);
        bool GetFrameRate(FbxTime::EMode &pTimeMode);

protected:
        virtual void Construct(const FbxImporter* pFrom);
        virtual void Destruct(bool pRecursive);

        void Reset();
    bool FileOpen(FbxFile* pFile = NULL);
        bool FileOpen(FbxStream* pStream, void* pStreamData);
        void FileClose();

        void GetImportOptionsInfo();
    bool IsNativeExtension ();

        //These two internal functions are only used to read old character pose data
        bool Initialize(FbxFile* pFile, const int pFileFormat=-1, FbxIOSettings* pIOSettings=NULL);
        bool Import(FbxDocument* pDocument, FbxIO* pFbxObject);

private:
        bool ImportProcess(FbxDocument* pDocument);

    int                                         mFileFormat;
    FbxReader*                          mReader;
        FbxString                               mExtractFolder;
    bool                                        mParseForGlobalSettings;
    FbxAxisSystem                       mAxisSystem;
    FbxSystemUnit                       mSystemUnits;
        FbxTime::EMode                  mFrameRate;
    bool                                        mParseForStatistics;
    FbxStatistics                       mStatistics;
#ifndef FBXSDK_ENV_WINRT
        FbxThread*                              mImportThread;
        FbxImportThreadArg*             mImportThreadArg;
        bool                                    mImportThreadResult;
        bool                                    mIsThreadImporting;
#endif /* !FBXSDK_ENV_WINRT */
    FbxProgress                         mProgress;
    FbxFile*                            mFile;
        FbxStream*                              mStream;
        void*                                   mStreamData;
        bool                                    mImportOptionsDone;
        FbxArray<FbxTakeInfo*>  mTakeInfo;
        FbxDocumentInfo*                mSceneInfo;
        FbxString                               mActiveAnimStackName;
        int                                             mMajorVersion;
        int                                             mMinorVersion;
        int                                             mRevisionVersion;
        FbxIOFileHeaderInfo*    mHeaderInfo;
        FbxIOSettings*                  mIOSettings;
        bool                                    mClientIOSettings;

        //For Initialize and Import
        friend class FbxReaderFbx5;
        friend class FbxReaderFbx6;
        friend struct FbxReaderFbx7_Impl;

        friend void ImportThread(void*);
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

class FBXSDK_DLL FbxEventPreImport : public FbxEvent<FbxEventPreImport>
{
    FBXSDK_EVENT_DECLARE(FbxEventPreImport);
public:
    inline FbxEventPreImport( FbxDocument* pDocument ) : mDocument(pDocument) {};

    FbxDocument* mDocument; 
};

class FBXSDK_DLL FbxEventPostImport : public FbxEvent<FbxEventPostImport>
{
    FBXSDK_EVENT_DECLARE(FbxEventPostImport);
public:
    inline FbxEventPostImport( FbxDocument* pDocument ) : mDocument(pDocument) {};

    FbxDocument* mDocument; 
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_IMPORTER_H_ */