fbxmanager.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 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_CORE_MANAGER_H_
#define _FBXSDK_CORE_MANAGER_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxobject.h>

#include <fbxsdk/scene/geometry/fbxcluster.h>
#include <fbxsdk/scene/geometry/fbxnode.h>
#include <fbxsdk/scene/shading/fbxsurfacematerial.h>
#include <fbxsdk/scene/shading/fbxtexture.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxIOSettings;
class FbxIOPluginRegistry;
class FbxAnimStack;
class FbxPlugin;
class FbxSceneReference;
class FbxUserNotification;
class FbxMessageEmitter;
class FbxLocalizationManager;
class FbxXRefManager;
class FbxPreviewManager;
class FbxManager_internal;

class FBXSDK_DLL FbxManager
{
public:
        static FbxManager* Create();

        virtual void Destroy();

        static const char* GetVersion(bool pFull=true);

        static void GetFileFormatVersion(int& pMajor, int& pMinor, int& pRevision);


        template <typename T1, typename T2> inline FbxClassId RegisterFbxClass(char const* pName, const T1*, const T2*, const char* pFbxFileTypeName=0, const char* pFbxFileSubTypeName=0)
        {
            T1::ClassId = Internal_RegisterFbxClass(pName, T2::ClassId, (FbxPlugCreateProc)T1::ManagerCreate, pFbxFileTypeName, pFbxFileSubTypeName);
            return T1::ClassId;
        }
     
        template <typename T> inline FbxClassId RegisterRuntimeFbxClass(char const* pName, const T*, const char* pFbxFileTypeName=0,const char* pFbxFileSubTypeName=0)
        {
            return Internal_RegisterFbxClass(pName, T::ClassId, (FbxPlugCreateProc)T::ManagerCreate, pFbxFileTypeName, pFbxFileSubTypeName);
        }
        
        inline void UnregisterRuntimeFbxClass(char const* pName)
        {
            FbxClassId lClassId = FindClass(pName);
            if( !(lClassId == FbxClassId()) )
            {
                Internal_UnregisterFbxClass(lClassId);
            }
        }
        
        template <typename T1,typename T2> inline FbxClassId OverrideFbxClass(const T1* pFBX_TYPE_Class, const T2* pFBX_TYPE_OverridenClass)
        {
            T1::ClassId  = Internal_OverrideFbxClass(T2::ClassId,(FbxPlugCreateProc)T1::ManagerCreate );
            return T1::ClassId;
        }

        FbxObject* CreateNewObjectFromClassId(FbxClassId pClassId, char const* pName, FbxObject* pContainer=NULL, const FbxObject* pCloneFrom=NULL);

        FbxClassId FindClass(const char* pClassName) const;

        FbxClassId FindFbxFileClass(const char* pFbxFileTypeName, const char* pFbxFileSubTypeName) const;

        template <typename T> inline void UnregisterFbxClass(const T* pFBX_TYPE_Class)
        {
            Internal_UnregisterFbxClass(T::ClassId);
            T::ClassId = FbxClassId();
        }

        FbxDataType CreateDataType(const char* pName, const EFbxType pType);

        int GetDataTypeCount() const;

        FbxDataType& GetDataType(const int pIndex) const;

        FbxDataType& GetDataTypeFromName(const char* pDataType) const;

        FbxUserNotification* GetUserNotification() const;

        void SetUserNotification(FbxUserNotification* pUN);

        virtual FbxIOSettings* GetIOSettings() const;

        virtual void SetIOSettings(FbxIOSettings* pIOSettings);


        FbxMessageEmitter& GetMessageEmitter();
        bool SetMessageEmitter(FbxMessageEmitter* pMessageEmitter);

        
        void AddLocalization(FbxLocalizationManager* pLocManager);

        void RemoveLocalization(FbxLocalizationManager* pLocManager);

        bool SetLocale(const char* pLocale);

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

        FbxPreviewManager& GetPreviewManager();

        FbxXRefManager& GetXRefManager();

        FbxLibrary* GetRootLibrary() const;
        FbxLibrary* GetSystemLibraries() const;
        FbxLibrary* GetUserLibraries() const;

        FbxIOPluginRegistry* GetIOPluginRegistry() const;

        bool LoadPluginsDirectory(const char* pFilename, const char* pExtensions=NULL);

        bool LoadPlugin(const char* pFilename);

        bool UnloadPlugins();

        bool EmitPluginsEvent(const FbxEventBase& pEvent);
       
        FbxArray<const FbxPlugin*> GetPlugins() const;

        int GetPluginCount() const;

        FbxPlugin* FindPlugin(const char* pName, const char* pVersion) const;


    // Add IOSettings in hierarchy from different modules

        void FillIOSettingsForReadersRegistered(FbxIOSettings& pIOS);

        void FillIOSettingsForWritersRegistered(FbxIOSettings& pIOS);

        void FillCommonIOSettings(FbxIOSettings& pIOS, bool pImport);

        void RegisterObject(const FbxPlug* pPlug);

        void UnregisterObject(const FbxPlug* pPlug);

        void RegisterObjects(const FbxArray<FbxObject*>& pArray);

        void UnregisterObjects(const FbxArray<FbxObject*>& pArray);

        void IncreaseDestroyingSceneFlag();
        void DecreaseDestroyingSceneFlag();
        int GetReferenceCount() const;

        FbxSceneReference* GetReference(int pIndex) const;

        int AddReference(FbxSceneReference* pReference);

        bool RemoveReference(FbxSceneReference* pReference);

        bool ClearReference(FbxSceneReference* pReference);

    static FbxString PrefixName(char const* pPrefix, char const* pName);

    int GetDocumentCount();

    FbxDocument* GetDocument(int pIndex);

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    static FbxManager*  GetDefaultManager();
    bool                CanDestroyFbxSrcObject(FbxObject* pObject, FbxObject* pSrcObject, bool pRecursive, bool pDependents) const;
    void                CreateMissingBindPoses(FbxScene* pScene);
    int                 GetBindPoseCount(FbxScene *pScene) const;
    int                 GetFbxClassCount() const;
    FbxClassId          GetNextFbxClass(FbxClassId pClassId /* invalid id: first one */) const;

protected:
    FbxManager();
    virtual ~FbxManager();

    void Clear();
    void ClassInit();
    void ClassRelease();
    void DataTypeInit();
    void DataTypeRelease();

private:
    void        Create_Common_Import_IOSettings_Groups(FbxIOSettings& pIOS);
    void        Create_Common_Export_IOSettings_Groups(FbxIOSettings& pIOS);
    void        Add_Common_Import_IOSettings(FbxIOSettings& pIOS);
    void        Add_Common_Export_IOSettings(FbxIOSettings& pIOS);
    void        Add_Common_RW_Import_IOSettings(FbxIOSettings& pIOS);
    void        Add_Common_RW_Export_IOSettings(FbxIOSettings& pIOS);

    FbxClassId  Internal_RegisterFbxClass(const char* pClassName, FbxClassId pParentClassId, FbxPlugCreateProc=0, char const* pFbxFileTypeName=0, char const* pFbxFileSubTypeName=0);
    bool        Internal_RegisterFbxClass(FbxClassId pClassId);
    FbxClassId  Internal_OverrideFbxClass(FbxClassId pClassId, FbxPlugCreateProc=0);
    void        Internal_UnregisterFbxClass(FbxClassId pClassId);

    void        RemoveObjectsOfType(const FbxClassId& pClassId);

    FbxArray<FbxObject*>                mObjects;
    FbxArray<FbxDocument*>              mDocuments;

    FbxIOSettings*                      mIOSettings;
    FbxIOPluginRegistry*                mRegistry;
    FbxUserNotification*                mUserNotification;
    FbxMessageEmitter*                  mMessageEmitter;
    FbxArray<FbxLocalizationManager*>   mLocalizationManagerArray;
    FbxArray<FbxSceneReference*>        mSceneReferenceArray;

    FbxArray<FbxObject*>                mDestroyingObjects;
    FbxArray<FbxDocument*>              mDestroyingDocuments;
    int                                 mIsDestroyingScene;

    FbxManager_internal*                mInternal;
    static FbxManager*                  smDefaultManager;

    FBXSDK_FRIEND_NEW();
    friend class FbxPose;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_MANAGER_H_ */