kfbxwriter.h

Go to the documentation of this file.

/****************************************************************************************

   Copyright (C) 2010 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 FBXFILESDK_KFBXIO_KFBXWRITER_H
#define FBXFILESDK_KFBXIO_KFBXWRITER_H

#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/components/kbaselib/klib/kerror.h>
#include <fbxfilesdk/components/kbaselib/klib/kstring.h>
#include <fbxfilesdk/components/kbaselib/klib/karrayul.h>

#include <fbxfilesdk/kfbxplugins/kfbxrenamingstrategy.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxNode;
class KFbxDocument;
class KFbxScene;
class KFbxSdkManager;
class KFbxExporter;
class KFbxIOSettings;
class KFbxObject;
class KFbx;
class KFbxProgress;

#define IOSP GetIOSettings()

class KFBX_DLL KFbxWriter
{
public:
    KFbxWriter(KFbxSdkManager& pManager, int pID);
    virtual ~KFbxWriter();

    typedef enum
    {
        eFILE_CORRUPTED,
        eFILE_NOT_OPENED,
        eFILE_NOT_CREATED,
        eOUT_OF_DISK_SPACE,
        eINVALID_DOCUMENT_HANDLE,
        eDOCUMENT_NOT_SUPPORTED,
        eUNIDENTIFIED_ERROR,
        eEMBEDDED_OUT_OF_SPACE,
        eERROR_COUNT
    } EError;

    enum KInfoRequest {
        eInfoExtension,         
        eInfoDescriptions,      
        eInfoVersions,          
        eInfoCompatibleDesc,    
        eInfoUILabel,           
        eReserved1 = 0xFBFB,
    };
    
    typedef KFbxWriter*             (*CreateFuncType)(KFbxSdkManager& pManager, KFbxExporter& pExporter, int pSubID, int pPluginID);

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

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

    virtual bool                    FileCreate(char* pFileName) = 0;
    
    virtual bool                    FileClose() = 0;
    
    virtual bool                    IsFileOpen() = 0;

    virtual void                    GetWriteOptions() = 0;

    virtual bool                    Write(KFbxDocument* pDocument) = 0;

    virtual bool                    PreprocessScene(KFbxScene &pScene) = 0;

    virtual bool                    PostprocessScene(KFbxScene &pScene) = 0;

    virtual void                    PluginWriteParameters(KFbxObject& pParams);

    virtual KFbxNode*               FindRootNode(KFbxScene& pScene);

    virtual bool                    CheckSpaceInNodeNameRecursive(KFbxNode* pNode, KString& pNodeNameList);

    bool                            SetFileExportVersion(KString pVersion);
 
    void                            SetRenamingMode(KFbxSceneRenamer::ERenamingMode pRenamingMode){mRenamingMode = pRenamingMode;}

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

    bool                            IsGenuine();

    KError&                         GetError();

    EError                          GetLastErrorID() const;

    const char*                     GetLastErrorString() const;

    void                            GetMessage(KString &pMessage) const;

    KString&                        GetMessage();

    void                            ClearMessage();

    virtual KFbxIOSettings * GetIOSettings();

    virtual void SetIOSettings(KFbxIOSettings * pIOSettings);

    virtual void SetProgressHandler(KFbxProgress *pProgress){}

protected:
    void                            PluginsWriteBegin(KFbxScene& pScene);
    void                            PluginsWrite(KFbx& pFbx, bool pWriteObjectId);
    void                            PluginsWriteEnd(KFbxScene& pScene);

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

    KFbxSdkManager&                 mManager;
    KString                         mFileVersion;
    double                          mResamplingRate;
    KFbxSceneRenamer::ERenamingMode mRenamingMode;

private:
    KError                          mError;
    KString                         mMessage;
    int                             mInternalID;
    KFbxIOSettings *                mIOSettings;

    friend struct KFbxWriterFbx7Impl;
};

#define IOS_REF (*GetIOSettings())

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXIO_KFBXWRITER_H