fbxsdk/fileio/fbxexternaldocreflistener.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2013 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 _FBXSDK_FILEIO_EXTERNAL_DOCREF_LISTENER_H_
#define _FBXSDK_FILEIO_EXTERNAL_DOCREF_LISTENER_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxlistener.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

struct FBXSDK_DLL FbxExternalDocumentInfo
{
    FbxString mDocumentName;      
    FbxString mClassName;         
    FbxString mParentFullName;    
    FbxString mFilePathUrl;       
};

class FBXSDK_DLL FbxEventReferencedDocument : public FbxEvent<FbxEventReferencedDocument>, public FbxExternalDocumentInfo
{
    FBXSDK_EVENT_DECLARE(FbxEventReferencedDocument);
public:
    FbxEventReferencedDocument() {}
};


class FbxExternalDocRefListenerData;

class FBXSDK_DLL FbxExternalDocRefListener : public FbxListener
{
public:
    FbxExternalDocRefListener( FbxManager & pManager, const FbxString & pDocFilePath );
    virtual ~FbxExternalDocRefListener();

    virtual void SetDocumentFilePath( const FbxString & 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 FbxEventReferencedDocument * pEvent);

protected:
    virtual FbxString MakeFilenameAbsolute(const FbxString & pFilename) const;
    virtual FbxDocument * FindDocument( const FbxString & pPathToDoc );
    virtual FbxDocument * LoadDocument(FbxObject * pParent, const FbxString & pClassName, const FbxString & pFilename);
    virtual bool ConnectToParentLibrary(const FbxExternalDocumentInfo &);
    virtual void TryConnectingDanglingLibraries();

private:
    FbxExternalDocRefListenerData * mData;
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_EXTERNAL_DOCREF_LISTENER_H_ */