Show in Contents

Add to Favorites

Home: FBX SDK Programmers Guide

 

 

 

FBX SDK Reference Guide: kfbxlibrary.h Source File

Go to the documentation of this file.

#ifndef _FBXSDK_LIBRARY_H_
#define _FBXSDK_LIBRARY_H_

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

 Copyright © 2001 - 2008 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 <kaydaradef.h>
#ifndef KFBX_DLL
    #define KFBX_DLL K_DLLIMPORT
#endif

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

#include <fbxfilesdk_nsbegin.h>

class KFbxWriterFbx6;
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;

        int GetSubLibraryCount(
            const KFbxImplementationFilter & pCriteria
        ) const;

        KFbxLibrary* GetSubLibrary(
            int pIndex,
            const KFbxImplementationFilter & pCriteria
        ) const;


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

        //
        // Returns a criteria filter which can be used to ... filter ... objects
        // when iterating items in the library; only real 'assets' will be returned,
        // rather than FBX support objects.  This includes, at this time,
        // lights, environments, materials and textures (maps)
        //
        // This is typically used to IMPORT from a library.
        //
        static KFbxCriteria GetAssetCriteriaFilter();

        //
        // Returns a filter which should be used when cloning / exporting objects --
        // this filters out objects that should stay in the asset library.
        //
        // This is typically used to EXPORT from a library (or CLONE from a library,
        // although CloneAsset does all the nitty gritty for you)
        //
        static KFbxCriteria GetAssetDependentsFilter();

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


        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 Node
    //
    // =======================================================================

        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

        public:
                // Clone
            virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;

        protected:

            // Constructor / Destructor
            KFbxLibrary(KFbxSdkManager& pManager, char const* pName);
            ~KFbxLibrary();
            virtual void Destruct   (bool pRecursive, bool pDependents);

            virtual void Construct(const KFbxLibrary* pFrom);

            mutable KFbxLocalizationManager * mLocalizationManager;

            friend class KFbxWriterFbx6;

        #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) :
                mFilePath( pFile ), 
                mAsset(NULL)
                {}

            // 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_nsend.h>

#endif //_FBXSDK_LIBRARY_H_