fbxplugin.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_PLUGIN_H_
#define _FBXSDK_CORE_PLUGIN_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxobject.h>

#include <fbxsdk/core/base/fbxstring.h>
#include <fbxsdk/core/base/fbxintrusivelist.h>
#include <fbxsdk/core/fbxmodule.h>
#include <fbxsdk/core/base/fbxscopedptr.h>

#include <fbxsdk/core/fbxemitter.h>
#include <fbxsdk/core/fbxlistener.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxManager;
class FbxLoadingStrategy;
class FbxPluginContainer;

#define FBXSDK_PLUGIN_DECLARE(Plugin)\
    FBXSDK_FRIEND_NEW();\
public:\
    static Plugin * Create(const FbxPluginDef& pDefinition, FbxModule pModuleHandle);\
    void Destroy();

#define FBXSDK_PLUGIN_IMPLEMENT(Plugin)\
    Plugin* Plugin::Create(const FbxPluginDef& pDefinition, FbxModule pModuleHandle){ return FbxNew<Plugin>(pDefinition, pModuleHandle); }\
    void Plugin::Destroy(){ FbxDelete(this); }

struct FBXSDK_DLL FbxPluginDef
{
    FbxPluginDef() :
        mName("Unknown Name"),
        mVersion("Unknown Version")
    {
    }

    FbxString mName;        
    FbxString mVersion; 
};

struct FBXSDK_DLL FbxPluginData
{
    FbxPluginData() :
        mQueryEmitter(NULL),
        mSDKManager(NULL),
        mPluginContainer(NULL)
    {
    }

    explicit FbxPluginData(const FbxPluginData& pOther) :
        mQueryEmitter(pOther.mQueryEmitter),
        mSDKManager(pOther.mSDKManager),
        mPluginContainer(pOther.mPluginContainer)
    {
    }

    FbxEmitter* mQueryEmitter;      
    FbxManager*             mSDKManager;        
    FbxPluginContainer*     mPluginContainer;   
};

class FBXSDK_DLL FbxPlugin : public FbxListener
{
    FBXSDK_INTRUSIVE_LIST_NODE(FbxPlugin, 1);

public:
    const FbxPluginDef& GetDefinition() const;

    FbxModule GetModuleHdl();

    virtual bool SpecificInitialize() = 0;

    virtual bool SpecificTerminate() = 0;

    virtual void WriteBegin(FbxScene& pScene);

    virtual void WriteParameters(FbxObject& pParams);

    virtual void WriteEnd(FbxScene& pScene);

    virtual void ReadBegin(FbxScene& pScene);

    virtual void ReadParameters(FbxObject& pParams);

    virtual void ReadEnd(FbxScene& pScene);

protected:
    explicit FbxPlugin(const FbxPluginDef& pDefinition, FbxModule pModuleHandle);

    virtual ~FbxPlugin();

    FbxPluginData& GetData();

    const FbxPluginData& GetData() const;

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
    inline FbxObject& GetPluginSettings() { return *(mPluginSettings.Get()); }
    inline const FbxObject& GetPluginSettings() const { return *(mPluginSettings.Get()); }
    template <typename EventType, typename ListernerType> inline FbxEventHandler* Bind(void (ListernerType::*pFunc)(const EventType*))
    {
        return FbxListener::Bind<EventType,ListernerType>(*(GetData().mQueryEmitter), pFunc );
    }
    virtual void Destroy() = 0;

private:
    bool                            Initialize(const FbxPluginData& pData);
    bool                            Terminate();

    bool                            mInitialized;
    FbxPluginData                   mData;
    FbxPluginDef                    mDefinition;
    FbxModule                       mModuleHandle;
    FbxObjectScopedPtr<FbxObject>   mPluginSettings;

    friend class FbxLoadingStrategy;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_PLUGIN_H_ */