kfbxexternaldocreflistener.h

Go to the documentation of this file.

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

   Copyright (C) 2010 Autodesk, Inc.
   All rights reserved.

   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.

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


#ifndef FBXFILESDK_KFBXIO_KFBXEXTERNALDOCREFLISTENER_H
#define FBXFILESDK_KFBXIO_KFBXEXTERNALDOCREFLISTENER_H


#include <fbxfilesdk/fbxfilesdk_def.h>

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

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxObject;
class KFbxDocument;
class KFbxSdkManager;

struct KFBX_DLL KFbxExternalDocumentInfo
{
    KString mDocumentName;      
    KString mClassName;         
    KString mParentFullName;    
    KString mFilePathUrl;       
};

class KFBX_DLL KFbxEventReferencedDocument : public KFbxEvent<KFbxEventReferencedDocument>, public KFbxExternalDocumentInfo
{
    KFBXEVENT_DECLARE(KFbxEventReferencedDocument);
public:
    KFbxEventReferencedDocument() {}
};


class KFBX_DLL KFbxExternalDocRefListenerData;

class KFBX_DLL KFbxExternalDocRefListener : public kfbxevents::KFbxListener
{
public:
    KFbxExternalDocRefListener( KFbxSdkManager & pManager, const KString & pDocFilePath );
    virtual ~KFbxExternalDocRefListener();

    virtual void SetDocumentFilePath( const KString & pDocFilePath );

    virtual bool AreAllExternalDocumentsStillValid() const;

    // 
    virtual bool WereAllExternalDocumentsValid() const;

    virtual void UnloadExternalDocuments();

    // External document reference event handler.
    //
    // Operation: calls FindDocument() to find the specified external document
    //            and if not found calls LoadDocument() either directly,
    //            if it has not parent, or via ConnectToParentLibrary().
    //            If its parent cannot be found, it's added to the dangling
    //            document list (and it is not loaded until it's parent is found).
    //            After, it tries to resolve dangling documents by calling
    //            TryConnectingDanglingLibraries().
    virtual void HandleEvent(const KFbxEventReferencedDocument * pEvent);

protected:
    virtual KString MakeFilenameAbsolute(const KString & pFilename) const;
    virtual KFbxDocument * FindDocument( const KString & pPathToDoc );
    virtual KFbxDocument * LoadDocument(KFbxObject * pParent, const KString & pClassName, const KString & pFilename);
    virtual bool ConnectToParentLibrary(const KFbxExternalDocumentInfo &);
    virtual void TryConnectingDanglingLibraries();

private:
    KFbxExternalDocRefListenerData * mData;
};

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXIO_KFBXEXTERNALDOCREFLISTENER_H