kfbxexporter.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXIO_KFBXEXPORTER_H
#define FBXFILESDK_KFBXIO_KFBXEXPORTER_H

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

 Copyright (C) 2001 - 2010 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material 
 (collectively the "Data") in these files contain unpublished information 
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
 Canada and United States of America federal copyright law and by international 
 treaties. 
 
 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE. 

**************************************************************************************/
#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/kfbxio/kfbxio.h>
#include <fbxfilesdk/kfbxio/kfbxiosettings.h>

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

#include <fbxfilesdk/kfbxplugins/kfbxrenamingstrategy.h>
#include <fbxfilesdk/kfbxevents/kfbxevents.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxDocument;
class KFbxExporterImp;
class KFbxFileHeaderInfo;

class KFBX_DLL KFbxEventPreExport : public KFbxEvent<KFbxEventPreExport>
{
    KFBXEVENT_DECLARE(KFbxEventPreExport);
public:
    inline KFbxEventPreExport( KFbxDocument* pDocument ) : mDocument(pDocument) {};

    KFbxDocument* mDocument;
};

class KFBX_DLL KFbxEventPostExport : public KFbxEvent<KFbxEventPostExport>
{
    KFBXEVENT_DECLARE(KFbxEventPostExport);
public:
    inline KFbxEventPostExport( KFbxDocument* pDocument ) : mDocument(pDocument) {};

    KFbxDocument* mDocument;
};

class KFBX_DLL KFbxExporter : public KFbxIO
{
    KFBXOBJECT_DECLARE(KFbxExporter, KFbxIO);

public:


    virtual bool Initialize(const char *pFileName, int pFileFormat = -1, KFbxIOSettings * pIOSettings = NULL);

    bool GetExportOptions();

    KFbxIOSettings * GetIOSettings();

    void SetIOSettings(KFbxIOSettings * pIOSettings);

    
    bool Export(KFbxDocument* pDocument, bool pNonBlocking=false);

    bool IsExporting(bool& pExportResult);

    float GetProgress(KString &pStatus);

    void SetProgressCallback(KFbxProgressCallback pHandler);
    


    int GetFileFormat();

    bool IsFBX();

    char const* const* GetCurrentWritableVersions();

    bool SetFileExportVersion(KString pVersion, KFbxSceneRenamer::ERenamingMode pRenamingMode);

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

    void SetDefaultRenderResolution(KString pCamName, KString pResolutionMode, double pW, double pH);

    KFbxFileHeaderInfo* GetFileHeaderInfo();



//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    bool GetExportOptions(KFbx* pFbxObject);

    //Internal use only, please use the other Export function to do your exports
    bool Export(KFbxDocument* pDocument, KFbx* pFbxObject);
private:
    friend void ExportThread(void*);
    bool ExportProcess(KFbxDocument* pDocument);

protected:
    KFbxExporter(KFbxSdkManager& pManager,char const *pName);
    virtual void Destruct(bool pRecursive, bool pDependents);

    void Reset();

    bool FileCreate();
    void FileClose();

    KFbxExporterImp* mImp;

    KString mStrFileVersion;
    double  mResamplingRate;
    KFbxSceneRenamer::ERenamingMode mRenamingMode;
    KFbxFileHeaderInfo*             mHeaderInfo;
    KFbxIOSettings*                 mIOSettings;
    bool                            mClientIOSettings;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXIO_KFBXEXPORTER_H