kfbxexporter.h

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 (C) 2001 - 2009 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 class KFbxFileHeaderInfo;
00066 
00068 class KFBX_DLL KFbxEventPreExport : public KFbxEvent<KFbxEventPreExport>
00069 {
00070     KFBXEVENT_DECLARE(KFbxEventPreExport);
00071 public:
00072     inline KFbxEventPreExport( KFbxDocument* pDocument ) : mDocument(pDocument) {};
00073 
00075     KFbxDocument* mDocument;
00076 };
00077 
00079 class KFBX_DLL KFbxEventPostExport : public KFbxEvent<KFbxEventPostExport>
00080 {
00081     KFBXEVENT_DECLARE(KFbxEventPostExport);
00082 public:
00083     inline KFbxEventPostExport( KFbxDocument* pDocument ) : mDocument(pDocument) {};
00084 
00086     KFbxDocument* mDocument;
00087 };
00088 
00098 class KFBX_DLL KFbxExporter : public KFbxIO
00099 {
00100     KFBXOBJECT_DECLARE(KFbxExporter, KFbxIO);
00101 
00102 public:
00103 
00108 
00116     virtual bool Initialize(const char *pFileName, int pFileFormat = -1);
00117 
00118 #ifdef KARCH_DEV_MACOSX_CFM
00119     virtual bool Initialize(const FSSpec &pMacFileSpec);
00120     virtual bool Initialize(const FSRef &pMacFileRef);
00121     virtual bool Initialize(const CFURLRef &pMacURL);
00122 #endif
00123 
00128     KFbxStreamOptions* GetExportOptions();
00129     
00136     bool Export(KFbxDocument* pDocument, KFbxStreamOptions* pStreamOptions = NULL);
00137 
00141     void ReleaseExportOptions(KFbxStreamOptions* pStreamOptions);
00142 
00144 
00149 
00153     K_DEPRECATED void SetFileFormat(int pFileFormat);
00154 
00158     int GetFileFormat();
00159 
00162     bool IsFBX();
00163 
00167     char const* const* GetCurrentWritableVersions();
00168 
00174     bool SetFileExportVersion(KString pVersion, KFbxSceneRenamer::ERenamingMode pRenamingMode);
00175 
00179     inline void SetResamplingRate(double pResamplingRate){mResamplingRate = pResamplingRate;}
00180 
00187     void SetDefaultRenderResolution(KString pCamName, KString pResolutionMode, double pW, double pH);
00188 
00192     KFbxFileHeaderInfo* GetFileHeaderInfo();
00193 
00195 
00196 
00198 //
00199 //  WARNING!
00200 //
00201 //  Anything beyond these lines may not be documented accurately and is 
00202 //  subject to change without notice.
00203 //
00205 
00206 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00207 
00213     KFbxStreamOptions* GetExportOptions(KFbx* pFbxObject);
00214 
00215     //Internal use only, please use the other Export function to do your exports
00216     bool Export(KFbxDocument* pDocument, KFbxStreamOptions* pStreamOptions, KFbx* pFbxObject);
00217 
00218 protected:
00219     KFbxExporter(KFbxSdkManager& pManager,char const *pName);
00220     virtual void Destruct(bool pRecursive, bool pDependents);
00221 
00222     void Reset();
00223 
00224     bool FileCreate();
00225     void FileClose();
00226 
00227     KFbxExporterImp* mImp;
00228 
00229     KString mStrFileVersion;
00230     double  mResamplingRate;
00231     KFbxSceneRenamer::ERenamingMode mRenamingMode;
00232     KFbxFileHeaderInfo*             mHeaderInfo;
00233 
00234 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00235 
00236 };
00237 
00238 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00239 
00240 #endif // FBXFILESDK_KFBXIO_KFBXEXPORTER_H
00241