FBX SDK Reference Guide: kfbxwriter.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_WRITER_H_
00005 #define _FBXSDK_WRITER_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright  2001 - 2008 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 
00042 #include <kaydaradef.h>
00043 
00044 #ifndef KFBX_DLL
00045     #define KFBX_DLL K_DLLIMPORT
00046 #endif
00047 
00048 
00049 #include <klib/kerror.h>
00050 #include <klib/kstring.h>
00051 #include <klib/karrayul.h>
00052 
00053 #include <kbaselib_forward.h>
00054 #ifndef MB_FBXSDK
00055 #include <kbaselib_nsuse.h>
00056 #endif
00057 #include <kfbxplugins/kfbxrenamingstrategy.h>
00058 
00059 #include <fbxfilesdk_nsbegin.h>
00060 
00061 class KFbxNode;
00062 class KFbxDocument;
00063 class KFbxScene;
00064 class KFbxSdkManager;
00065 class KFbxExporter;
00066 class KFbxStreamOptions;
00067 class KFbxIOSettings;
00068 
00069 class KFBX_DLL KFbxWriter
00070 {
00071 
00072 public:
00073 
00074     KFbxWriter(KFbxSdkManager& pManager);
00075     virtual ~KFbxWriter();
00076 
00077     virtual bool FileCreate(char* pFileName) = 0;
00078     virtual bool FileClose() = 0;
00079     virtual bool IsFileOpen() = 0;
00080 
00081     virtual KFbxStreamOptions* GetWriteOptions() = 0;
00082     virtual bool Write(KFbxDocument* pDocument, KFbxStreamOptions* pStreamOptions) = 0;
00083 
00084     virtual bool PreprocessScene(KFbxScene &pScene) = 0;
00085     virtual bool PostprocessScene(KFbxScene &pScene) = 0;
00086 
00087     bool SetFileExportVersion(KString pVersion);
00088 
00089     void SetRenamingMode(KFbxSceneRenamer::ERenamingMode pRenamingMode){mRenamingMode = pRenamingMode;}
00090     inline void SetResamplingRate(double pResamplingRate){mResamplingRate = pResamplingRate;}
00091 
00093     typedef enum
00094     {
00095         eFILE_CORRUPTED,
00096         eFILE_NOT_OPENED,
00097         eFILE_NOT_CREATED,
00098         eOUT_OF_DISK_SPACE,
00099         eSTREAM_OPTIONS_NOT_SET,
00100         eINVALID_DOCUMENT_HANDLE,
00101         eDOCUMENT_NOT_SUPPORTED,
00102         eUNIDENTIFIED_ERROR,
00103         eEMBEDDED_OUT_OF_SPACE,
00104         eERROR_COUNT
00105     } EError;
00106 
00107     KError&  GetError();
00108     EError   GetLastErrorID() const;
00109     const char* GetLastErrorString() const;
00110 
00111     void     GetMessage(KString &pMessage) const;
00112     void     ClearMessage();
00113 
00114 
00115     KFbxWriter& operator=(KFbxWriter const&) { return *this; }
00116     virtual KFbxNode* FindRootNode(KFbxScene& pScene);
00117     virtual bool CheckSpaceInNodeNameRecursive(KFbxNode* pNode, KString& pNodeNameList);
00118 
00119     typedef KFbxWriter* (*CreateFuncType)(KFbxSdkManager& pManager,
00120                                           KFbxExporter& pExporter,
00121                                           int pID);
00122 
00123     typedef void (*IOSettingsFillerFuncType)(KFbxIOSettings& pIOS);
00124 
00125     enum KInfoRequest {
00126         eInfoExtension, // return a null terminated char const* const*
00127         eInfoDescriptions, // return a null terminated char const* const*
00128         eInfoVersions, // return a null terminated char const* const*
00129         eReserved1 = 0xFBFB,
00130     };
00131 
00132     typedef void* (*GetInfoFuncType)(KInfoRequest pRequest, int pWriterTypeId);
00133 
00134 protected:
00135     KFbxSdkManager& mManager;
00136     KError mError;
00137 
00138     KString         mMessage;
00139     KString mFileVersion;
00140     double  mResamplingRate;
00141     KFbxSceneRenamer::ERenamingMode mRenamingMode;
00142 };
00143 
00144 #include <fbxfilesdk_nsend.h>
00145 
00146 #endif // #ifndef _FBXSDK_WRITER_H_
00147 
00148