FBX SDK Reference Guide: kfbxexporter.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXIO_KFBXEXPORTER_H
00005 #define FBXFILESDK_KFBXIO_KFBXEXPORTER_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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
00044 #include <fbxfilesdk/kfbxio/kfbxio.h>
00045 
00046 #include <fbxfilesdk/components/kbaselib/klib/kstring.h>
00047 #include <fbxfilesdk/components/kbaselib/klib/karrayul.h>
00048 
00049 #include <fbxfilesdk/components/kbaselib/kbaselib_forward.h>
00050 
00051 #ifdef KARCH_DEV_MACOSX_CFM
00052     #include <CFURL.h>
00053     #include <Files.h>
00054 #endif
00055 
00056 #include <fbxfilesdk/kfbxplugins/kfbxrenamingstrategy.h>
00057 #include <fbxfilesdk/kfbxevents/kfbxevents.h>
00058 
00059 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00060 
00061 class KFbxDocument;
00062 class KFbxExporterImp;
00063 class KFbxStreamOptionsFbxWriter;
00064 class KFbxStreamOptions;
00065 
00067 class KFBX_DLL KFbxEventPreExport : public KFbxEvent<KFbxEventPreExport>
00068 {
00069     KFBXEVENT_DECLARE(KFbxEventPreExport);
00070 public:
00071     inline KFbxEventPreExport( KFbxDocument* pDocument ) : mDocument(pDocument) {};
00072 
00074     KFbxDocument* mDocument;
00075 };
00076 
00078 class KFBX_DLL KFbxEventPostExport : public KFbxEvent<KFbxEventPostExport>
00079 {
00080     KFBXEVENT_DECLARE(KFbxEventPostExport);
00081 public:
00082     inline KFbxEventPostExport( KFbxDocument* pDocument ) : mDocument(pDocument) {};
00083 
00085     KFbxDocument* mDocument;
00086 };
00087 
00097 class KFBX_DLL KFbxExporter : public KFbxIO
00098 {
00099     KFBXOBJECT_DECLARE(KFbxExporter,KFbxIO);
00100 
00101 public:
00102 
00107 
00113     virtual bool Initialize(const char *pFileName);
00114 
00115 #ifdef KARCH_DEV_MACOSX_CFM
00116     virtual bool Initialize(const FSSpec &pMacFileSpec);
00117     virtual bool Initialize(const FSRef &pMacFileRef);
00118     virtual bool Initialize(const CFURLRef &pMacURL);
00119 #endif
00120 
00125     KFbxStreamOptions* GetExportOptions();
00126     
00133     bool Export(KFbxDocument* pDocument, KFbxStreamOptions* pStreamOptions = NULL);
00134 
00138     void ReleaseExportOptions(KFbxStreamOptions* pStreamOptions);
00139 
00141 
00146 
00150     void SetFileFormat(int pFileFormat);
00151 
00155     int GetFileFormat();
00156 
00159     bool IsFBX();
00160 
00164     char const* const* GetCurrentWritableVersions();
00165 
00171     bool SetFileExportVersion(KString pVersion, KFbxSceneRenamer::ERenamingMode pRenamingMode);
00172 
00176     inline void SetResamplingRate(double pResamplingRate){mResamplingRate = pResamplingRate;}
00177 
00179 
00180 
00182 //
00183 //  WARNING!
00184 //
00185 //  Anything beyond these lines may not be documented accurately and is 
00186 //  subject to change without notice.
00187 //
00189 
00190 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00191 
00197     KFbxStreamOptions* GetExportOptions(KFbx* pFbxObject);
00198 
00199     //Internal use only, please use the other Export function to do your exports
00200     bool Export(KFbxDocument* pDocument, KFbxStreamOptions* pStreamOptions, KFbx* pFbxObject);
00201 
00202 protected:
00203     KFbxExporter(KFbxSdkManager& pManager,char const *pName);
00204     virtual ~KFbxExporter();
00205 
00206     void Reset();
00207 
00208     bool FileCreate();
00209     void FileClose();
00210 
00211     KFbxExporterImp* mImp;
00212 
00213     KString mStrFileVersion;
00214     double  mResamplingRate;
00215     KFbxSceneRenamer::ERenamingMode mRenamingMode;
00216 
00217 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00218 
00219 };
00220 
00221 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00222 
00223 #endif // FBXFILESDK_KFBXIO_KFBXEXPORTER_H
00224