fbxexporter.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_EXPORTER_H_
#define _FBXSDK_FILEIO_EXPORTER_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxevent.h>
#include <fbxsdk/core/base/fbxstring.h>
#include <fbxsdk/fileio/fbxiobase.h>
#include <fbxsdk/fileio/fbxiosettings.h>
#include <fbxsdk/fileio/fbxprogress.h>
#include <fbxsdk/utils/fbxrenamingstrategy.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxIO;
class FbxIOFileHeaderInfo;
class FbxThread;
class FbxWriter;
class FbxEmbeddedFileCallback;

struct FbxExportThreadArg;

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

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

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

        bool GetExportOptions();

        FbxIOSettings* GetIOSettings();

        void SetIOSettings(FbxIOSettings* pIOSettings);


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

    #if !defined(FBXSDK_ENV_WINSTORE) && !defined(FBXSDK_ENV_EMSCRIPTEN)

        bool IsExporting(bool& pExportResult);
    #endif /* !FBXSDK_ENV_WINSTORE && ! FBXSDK_ENV_EMSCRIPTEN */

        float GetProgress(FbxString* pStatus=NULL);

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

        void SetEmbeddedFileWriteCallback(FbxEmbeddedFileCallback* pCallback);

        FbxEmbeddedFileCallback* GetEmbeddedFileWriteCallback();

        int GetFileFormat();

        bool IsFBX();

        char const* const* GetCurrentWritableVersions();

        bool SetFileExportVersion(FbxString pVersion, FbxSceneRenamer::ERenamingMode pRenamingMode=FbxSceneRenamer::eNone);

        inline void SetResamplingRate(double pResamplingRate){ mResamplingRate = pResamplingRate; }

        void SetDefaultRenderResolution(FbxString pCamName, FbxString pResolutionMode, double pW, double pH);

        FbxIOFileHeaderInfo* GetFileHeaderInfo();

/*****************************************************************************************************************************
** 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
    void TCSetDefinition(int pType);
    bool GetExportOptions(FbxIO* pFbxObject);
    bool Export(FbxDocument* pDocument, FbxIO* pFbxObject);

protected:
    void Construct(const FbxObject* pFrom) override;
    void Destruct(bool pRecursive) override;
    virtual void SetOrCreateIOSettings(FbxIOSettings* pIOSettings, bool pAllowNULL);

    void Reset();
    bool FileCreate();
    void FileClose();

private:
    bool ExportProcess(FbxDocument* pDocument);

    int                             mFileFormat;
    FbxWriter*                      mWriter;
#if !defined(FBXSDK_ENV_WINSTORE) && !defined(FBXSDK_ENV_EMSCRIPTEN)
    FbxThread*                      mExportThread;
    FbxExportThreadArg*             mExportThreadArg;
    bool                            mExportThreadResult;
    bool                            mIsThreadExporting;
#endif /* !FBXSDK_ENV_WINSTORE && !FBXSDK_ENV_EMSCRIPTEN */
    FbxProgress                     mProgress;
    FbxStream*                      mStream;
    void*                           mStreamData;
    FbxString                       mStrFileVersion;
    double                          mResamplingRate;
    FbxSceneRenamer::ERenamingMode  mRenamingMode;
    FbxIOFileHeaderInfo*            mHeaderInfo;
    FbxIOSettings*                  mIOSettings;
    bool                            mClientIOSettings;
    FbxEmbeddedFileCallback*        mEmbeddedFileCallback;

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

class FBXSDK_DLL FbxEventPreExport : public FbxEvent<FbxEventPreExport>
{
    FBXSDK_EVENT_DECLARE(FbxEventPreExport);

public:
    FbxEventPreExport(FbxDocument* pDocument) : mDocument(pDocument) {};

    FbxDocument* mDocument;
};

class FBXSDK_DLL FbxEventPostExport : public FbxEvent<FbxEventPostExport>
{
    FBXSDK_EVENT_DECLARE(FbxEventPostExport);

public:
    FbxEventPostExport(FbxDocument* pDocument) : mDocument(pDocument) {};

    FbxDocument* mDocument;
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_EXPORTER_H_ */