kfbxlibrary.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_KFBXPLUGINS_KFBXLIBRARY_H
#define FBXFILESDK_KFBXPLUGINS_KFBXLIBRARY_H


#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/fbxcore/fbxcollection/kfbxdocument.h>
#include <fbxfilesdk/kfbxplugins/kfbxobjectfilter.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxLocalizationManager;
class KFbxCriteria;

class KFBX_DLL KFbxLibrary : public KFbxDocument
{
    KFBXOBJECT_DECLARE(KFbxLibrary,KFbxDocument);

public:
    KFbxLibrary* GetParentLibrary(void) const;

    void SystemLibrary(bool pSystemLibrary);

    bool IsSystemLibrary() const;

    void LocalizationBaseNamePrefix(const char* pPrefix);

    KString LocalizationBaseNamePrefix() const;

    // =======================================================================
    //
    // sub-library
    //
    // =======================================================================

    bool AddSubLibrary(KFbxLibrary* pSubLibrary);

    bool RemoveSubLibrary(KFbxLibrary* pSubLibrary);

    int GetSubLibraryCount(void) const;

    KFbxLibrary* GetSubLibrary(int pIndex) const;

    KFbxObject* CloneAsset( KFbxObject* pToClone, KFbxObject* pOptionalDestinationContainer = NULL) const;

    
    static KFbxCriteria GetAssetCriteriaFilter();

    static KFbxCriteria GetAssetDependentsFilter();

    bool ImportAssets(KFbxLibrary* pSrcLibrary);

    bool ImportAssets(KFbxLibrary* pSrcLibrary, const KFbxCriteria& pAssetFilter);


    template < class T > T* InstantiateMember( T const* pFBX_TYPE, const KFbxObjectFilter& pFilter, bool pRecurse = true, KFbxObject* pOptContainer = NULL);


    // =======================================================================
    //
    // Localization
    //
    // =======================================================================
    KFbxLocalizationManager & GetLocalizationManager() const;

    virtual const char * Localize( const char * pID, const char * pDefault = NULL ) const;

    // =======================================================================
    //
    // Shading Object
    //
    // =======================================================================

    bool AddShadingObject(KFbxObject* pShadingObject);

    bool RemoveShadingObject(KFbxObject* pShadingObject);

    int GetShadingObjectCount(void) const;

    KFbxObject* GetShadingObject(int pIndex) const;

    int GetShadingObjectCount(
        const KFbxImplementationFilter & pCriteria
    ) const;

    KFbxObject* GetShadingObject(
        int pIndex,
        const KFbxImplementationFilter & pCriteria
    ) const;

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    // Constructor / Destructor
    KFbxLibrary(KFbxSdkManager& pManager, char const* pName);

    virtual void Destruct(bool pRecursive, bool pDependents);
    virtual void Construct(const KFbxLibrary* pFrom);

    mutable KFbxLocalizationManager * mLocalizationManager;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};


    template < class T > T* KFbxLibrary::InstantiateMember( T const* pFBX_TYPE, const KFbxObjectFilter& pFilter, bool pRecurse, KFbxObject* pOptContainer )
    {
        // first check all materials in the library.
        int i = 0;
        for( i = 0; i < GetMemberCount( FBX_TYPE(T) ); ++i )
        {
            T* lObject = GetMember( FBX_TYPE(T), i );
            if( pFilter.Match(lObject) )
                return KFbxCast<T>(CloneAsset(lObject,pOptContainer));
        }

        if( pRecurse )
        {
            // then check all materials in each sub-library.
            for( i = 0; i < GetMemberCount( FBX_TYPE(KFbxLibrary) ); ++i )
            {
                KFbxLibrary* lLibrary = GetMember( FBX_TYPE(KFbxLibrary), i );
                T* lClonedObject = lLibrary->InstantiateMember( pFBX_TYPE, pFilter, pRecurse, pOptContainer );
                if( lClonedObject )
                    return lClonedObject;
            }
        }

        return NULL;
    }


    class KFBX_DLL KFbxEventPopulateSystemLibrary : public KFbxEvent<KFbxEventPopulateSystemLibrary>
    {
      KFBXEVENT_DECLARE(KFbxEventPopulateSystemLibrary)

        public:         

            KFbxEventPopulateSystemLibrary(KFbxLibrary *pLibrary) { mLibrary = pLibrary; }

       
            public:

                inline KFbxLibrary* GetLibrary() const { return mLibrary; }
            private:
                KFbxLibrary*    mLibrary;
    };

    class KFBX_DLL KFbxEventUpdateSystemLibrary : public KFbxEvent<KFbxEventUpdateSystemLibrary>
    {
        KFBXEVENT_DECLARE(KFbxEventUpdateSystemLibrary)
        public:

            KFbxEventUpdateSystemLibrary(KFbxLibrary *pLibrary) { mLibrary = pLibrary; }



            inline KFbxLibrary* GetLibrary() const { return mLibrary; }

        private:
                KFbxLibrary*    mLibrary;
    };

    class KFBX_DLL KFbxEventWriteLocalization : public KFbxEvent<KFbxEventWriteLocalization>
    {
        KFBXEVENT_DECLARE(KFbxEventWriteLocalization)
        public:
            KFbxEventWriteLocalization(KFbxLibrary *pAssetLibrary) { mAssetLibrary = pAssetLibrary; }

            inline KFbxLibrary* GetLibrary() const { return mAssetLibrary; }

        private:
            KFbxLibrary*    mAssetLibrary;
    };

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

    // Some assets correspond 1:1 with files containing their actual data.
    class KFBX_DLL KFbxEventMapAssetFileToAssetObject : public KFbxEvent<KFbxEventMapAssetFileToAssetObject>
    {
        KFBXEVENT_DECLARE(KFbxEventMapAssetFileToAssetObject)
        public:

            // pFile - The asset file to query
            KFbxEventMapAssetFileToAssetObject(const char* pFile) :
                mAsset(NULL),
                mFilePath( pFile )
                {}

            // listeners query this
            inline const char* GetFilePath() const { return mFilePath; }

            // listeners set this
            mutable KFbxObject* mAsset;

        private:
            KString mFilePath;
    };

    #endif //DOXYGEN_SHOULD_SKIP_THIS

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXLIBRARY_H