kfbximporter.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXIO_KFBXIMPORTER_H
#define FBXFILESDK_KFBXIO_KFBXIMPORTER_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/kfbxevents/kfbxevents.h>

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

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

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxDocument;
class KFbxImporterImp;
class KFbxTakeInfo;
class KFbxDocumentInfo;
class KFbxAxisSystem;
class KFbxSystemUnit;
class KFbxStatistics;
class KFile;
class KFbxFileHeaderInfo;

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

    KFbxDocument* mDocument; 
};

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

    KFbxDocument* mDocument; 
};

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

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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

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

    virtual KFile * GetFile();
#endif 

    void GetFileVersion(int& pMajor, int& pMinor, int& pRevision);

    bool GetDefaultRenderResolution(KString& pCamName, KString& pResolutionMode, double& pW, double& pH);

    KFbxFileHeaderInfo* GetFileHeaderInfo();

    typedef enum 
    {
        eSTREAMOPTIONS_PARSE_FILE,  // Parse the file
        eSTREAMOPTIONS_FAST,        // Do not parse the file
        eSTREAMOPTIONS_COUNT
    } EStreamOptionsGeneration;

      bool GetImportOptions(EStreamOptionsGeneration pStreamOptionsGeneration = eSTREAMOPTIONS_PARSE_FILE); 

      bool GetImportOptions(KFbx* pFbxObject);

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

      bool IsImporting(bool& pImportResult);

      float GetProgress(KString &pStatus);

      void SetProgressCallback(KFbxProgressCallback pHandler);

    void SetEmbeddingExtractionFolder(const char* pExtractFolder);

    const char* GetEmbeddingExtractionFolder();

      KFbxIOSettings* GetIOSettings();

      void SetIOSettings(KFbxIOSettings* pIOSettings);

      void SetPassword(char* pPassword);

    
      int GetAnimStackCount();

      KFbxTakeInfo* GetTakeInfo(int pIndex);

      KString GetActiveAnimStackName();



    KFbxDocumentInfo* GetSceneInfo();



    int GetFileFormat ();

    bool IsFBX();

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

    void ParseForGlobalSettings(bool pState);

    void ParseForStatistics(bool pState);

    bool GetAxisInfo(KFbxAxisSystem* pAxisSystem, KFbxSystemUnit* pSystemUnits);

    bool GetStatistics(KFbxStatistics* pStatistics);

    bool GetFrameRate(KTime::ETimeMode &pTimeMode);


#ifndef DOXYGEN_SHOULD_SKIP_THIS
    //Internal use only, please use the other Import function to do your imports
    bool Import(KFbxDocument* pDocument, KFbx* pFbxObject);

private:
    friend void ImportThread(void*);
    bool ImportProcess(KFbxDocument* pDocument);

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

    void Reset();

    bool FileOpen(KFile* pFile = NULL);
    void FileClose();
    
    bool IsNativeExtension ();

    KFbxImporterImp*                mImp;
    KFile*                          mFile;
    bool                            mImportOptionsDone;
    KArrayTemplate<KFbxTakeInfo*>   mTakeInfo;
    KFbxDocumentInfo*               mSceneInfo;
    KString                         mActiveAnimStackName;
    int                             mMajorVersion;
    int                             mMinorVersion;
    int                             mRevisionVersion;
    KFbxFileHeaderInfo              *mHeaderInfo;
    KFbxIOSettings*                 mIOSettings;
    bool                            mClientIOSettings;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXIO_KFBXIMPORTER_H