fbximporter.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_IMPORTER_H_
#define _FBXSDK_FILEIO_IMPORTER_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxstring.h>
#include <fbxsdk/core/base/fbxarray.h>
#include <fbxsdk/core/fbxevent.h>

#include <fbxsdk/fileio/fbxiobase.h>
#include <fbxsdk/fileio/fbxiosettings.h>
#include <fbxsdk/fileio/fbxprogress.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxDocument;
class FbxImporter_Impl;
class FbxTakeInfo;
class FbxDocumentInfo;
class FbxAxisSystem;
class FbxSystemUnit;
class FbxStatistics;
class FbxFile;
class FbxIOFileHeaderInfo;
class FbxIO;

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; 
};

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);

#ifndef DOXYGEN_SHOULD_SKIP_THIS

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

    virtual FbxFile * GetFile();
#endif 

    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);

      bool IsImporting(bool& pImportResult);

      float GetProgress(FbxString &pStatus);

      void SetProgressCallback(FbxProgressCallback pHandler);

    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 may not be documented accurately and is 
//  subject to change without notice.
//

    void ParseForGlobalSettings(bool pState);

    void ParseForStatistics(bool pState);

    bool GetAxisInfo(FbxAxisSystem* pAxisSystem, FbxSystemUnit* pSystemUnits);

    bool GetStatistics(FbxStatistics* pStatistics);

    bool GetFrameRate(FbxTime::EMode &pTimeMode);


#ifndef DOXYGEN_SHOULD_SKIP_THIS
    //Internal use only, please use the other Import function to do your imports
    bool Import(FbxDocument* pDocument, FbxIO* pFbxObject);

private:
    friend void ImportThread(void*);
    bool ImportProcess(FbxDocument* pDocument);

protected:
    void GetImportOptionsInfo();
    
    FbxImporter(FbxManager& pManager,char const* pName);
    virtual void Destruct(bool pRecursive, bool pDependents);

    void Reset();

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

    FbxImporter_Impl*               mImp;
    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;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_IMPORTER_H_ */