FBX SDK Reference Guide: kfbxexporter.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_EXPORTER_H_
00005 #define _FBXSDK_EXPORTER_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 
00043 #include <kaydaradef.h>
00044 #ifndef KFBX_DLL 
00045     #define KFBX_DLL K_DLLIMPORT
00046 #endif
00047 
00048 #include <kfbxio/kfbxio.h>
00049 
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 
00058 #ifdef KARCH_DEV_MACOSX_CFM
00059     #include <CFURL.h>
00060     #include <Files.h>
00061 #endif
00062 
00063 #include <kfbxplugins/kfbxrenamingstrategy.h>
00064 #include <kfbxevents/kfbxevents.h>
00065 
00066 #include <fbxfilesdk_nsbegin.h>
00067 
00068 class KFbxDocument;
00069 class KFbxExporterImp;
00070 class KFbxStreamOptionsFbxWriter;
00071 class KFbxStreamOptions;
00072 
00074 class KFBX_DLL KFbxEventPreExport : public KFbxEvent<KFbxEventPreExport>
00075 {
00076     KFBXEVENT_DECLARE(KFbxEventPreExport);
00077 public:
00078     inline KFbxEventPreExport( KFbxDocument* pDocument ) : mDocument(pDocument) {};
00079 
00081     KFbxDocument* mDocument;
00082 };
00083 
00085 class KFBX_DLL KFbxEventPostExport : public KFbxEvent<KFbxEventPostExport>
00086 {
00087     KFBXEVENT_DECLARE(KFbxEventPostExport);
00088 public:
00089     inline KFbxEventPostExport( KFbxDocument* pDocument ) : mDocument(pDocument) {};
00090 
00092     KFbxDocument* mDocument;
00093 };
00094 
00104 class KFBX_DLL KFbxExporter : public KFbxIO
00105 {
00106     KFBXOBJECT_DECLARE(KFbxExporter,KFbxIO);
00107 
00108 public:
00109 
00114 
00120     virtual bool Initialize(const char *pFileName);
00121 
00122 #ifdef KARCH_DEV_MACOSX_CFM
00123     virtual bool Initialize(const FSSpec &pMacFileSpec);
00124     virtual bool Initialize(const FSRef &pMacFileRef);
00125     virtual bool Initialize(const CFURLRef &pMacURL);
00126 #endif
00127 
00132     KFbxStreamOptions* GetExportOptions();
00133     
00140     bool Export(KFbxDocument* pDocument, KFbxStreamOptions* pStreamOptions = NULL);
00141 
00145     void ReleaseExportOptions(KFbxStreamOptions* pStreamOptions);
00146 
00148 
00153 
00157     void SetFileFormat(int pFileFormat);
00158 
00162     int GetFileFormat();
00163 
00166     bool IsFBX();
00167 
00171     char const* const* GetCurrentWritableVersions();
00172 
00178     bool SetFileExportVersion(KString pVersion, KFbxSceneRenamer::ERenamingMode pRenamingMode);
00179 
00183     inline void SetResamplingRate(double pResamplingRate){mResamplingRate = pResamplingRate;}
00184 
00186 
00187 
00189 //
00190 //  WARNING!
00191 //
00192 //  Anything beyond these lines may not be documented accurately and is 
00193 //  subject to change without notice.
00194 //
00196 
00197 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00198 
00204     KFbxStreamOptions* GetExportOptions(KFbx* pFbxObject);
00205 
00213     bool Export(KFbxDocument* pDocument, KFbxStreamOptions* pStreamOptions, KFbx* pFbxObject);
00214 
00215 
00216 protected:
00217 
00218     KFbxExporter(KFbxSdkManager& pManager,char const *pName);
00219     virtual ~KFbxExporter();
00220 
00221     void Reset();
00222 
00223     bool FileCreate();
00224     void FileClose();
00225 
00226     KFbxExporterImp* mImp;
00227 
00228     KString mStrFileVersion;
00229     double  mResamplingRate;
00230     KFbxSceneRenamer::ERenamingMode mRenamingMode;
00231 
00232 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00233 
00234 };
00235 
00236 #include <fbxfilesdk_nsend.h>
00237 
00238 #endif // #ifndef _FBXSDK_EXPORTER_H_
00239 
00240