fbxwriter.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_WRITER_H_
#define _FBXSDK_FILEIO_WRITER_H_

#include <fbxsdk/fbxsdk_def.h>

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

#include <fbxsdk/utils/fbxrenamingstrategy.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxNode;
class FbxDocument;
class FbxScene;
class FbxManager;
class FbxExporter;
class FbxIOSettings;
class FbxObject;
class FbxIO;
class FbxProgress;
class FbxStream;

#define IOSP GetIOSettings()

class FBXSDK_DLL FbxWriter
{
public:
    FbxWriter(FbxManager& pManager, int pID);
    virtual ~FbxWriter();

    enum EErrorCode
    {
        eFileCorrupted,
        eFileNotOpened,
        eFileNotCreated,
        eOutOfSpace,
        eInvalidDocumentHandle,
        eDocumentNotSupported,
        eUnknownError,
        eEmbeddedOutOfSpace,
        eErrorCount
    };

    enum EInfoRequest
    {
        eInfoExtension,         
        eInfoDescriptions,      
        eInfoVersions,          
        eInfoCompatibleDesc,    
        eInfoUILabel,           
        eReserved1 = 0xFBFB,
    };
    
    typedef FbxWriter*              (*CreateFuncType)(FbxManager& pManager, FbxExporter& pExporter, int pSubID, int pPluginID);

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

    typedef void*                   (*GetInfoFuncType)(EInfoRequest pRequest, int pWriterTypeId);

    virtual bool                    FileCreate(char* pFileName) = 0;

    virtual bool                    FileCreate(FbxStream* pStream, void* pStreamData);
    
    virtual bool                    FileClose() = 0;
    
    virtual bool                    IsFileOpen() = 0;

    virtual void                    GetWriteOptions() = 0;

    virtual bool                    Write(FbxDocument* pDocument) = 0;

    virtual bool                    PreprocessScene(FbxScene &pScene) = 0;

    virtual bool                    PostprocessScene(FbxScene &pScene) = 0;

    virtual void                    PluginWriteParameters(FbxObject& pParams);

    virtual FbxNode*                FindRootNode(FbxScene& pScene);

    virtual bool                    CheckSpaceInNodeNameRecursive(FbxNode* pNode, FbxString& pNodeNameList);

    bool                            SetFileExportVersion(FbxString pVersion);
 
    void                            SetRenamingMode(FbxSceneRenamer::ERenamingMode pRenamingMode){mRenamingMode = pRenamingMode;}

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

    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 bool SupportsStreams() const;

protected:
    void                            PluginsWriteBegin(FbxScene& pScene);
    void                            PluginsWrite(FbxIO& pFbx, bool pWriteObjectId);
    void                            PluginsWriteEnd(FbxScene& pScene);

    FbxWriter&                      operator=(FbxWriter const&) { return *this; }

    FbxManager&                 mManager;
    FbxString                           mFileVersion;
    double                          mResamplingRate;
    FbxSceneRenamer::ERenamingMode  mRenamingMode;

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

    friend struct FbxWriterFbx7_Impl;
};

#define IOS_REF (*GetIOSettings())

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_WRITER_H_ */