KFbxPlugin Class Reference

#include <kfbxplugin.h>

Inheritance diagram for KFbxPlugin:

[legend]

List of all members.

---

Detailed Description

Abstract class used to implement plug-ins.

Definition at line 111 of file kfbxplugin.h.

Public Member Functions
virtual void	WriteBegin (KFbxScene &pScene)
virtual void	WriteParameters (KFbxObject &pParams)
virtual void	WriteEnd (KFbxScene &pScene)
virtual void	ReadBegin (KFbxScene &pScene)
virtual void	ReadParameters (KFbxObject &pParams)
virtual void	ReadEnd (KFbxScene &pScene)
Public interface
virtual	~KFbxPlugin ()
	Destructor.
const KFbxPluginDefinition &	GetDefinition () const
	const accessor to the plug-in definition.
virtual void	Destroy ()=0
	Destructor.
KFbxObject &	GetPluginSettings ()
	Destructor.
const KFbxObject &	GetPluginSettings () const
	Destructor.
User implementation
virtual bool	SpecificInitialize ()=0
	Method called after plug-in construction.
virtual bool	SpecificTerminate ()=0
	Method called before plug-in destruction.
Event registration
template<typename EventType, typename ListernerType>
KFbxEventHandler *	Bind (void(ListernerType::*pFunc)(const EventType *))
kLibHandle	GetLibraryHandle ()
	Retrieve module instance handle.
Protected Member Functions
	KFbxPlugin (const KFbxPluginDefinition &pDefinition, kLibHandle pLibHandle)
	Constructor Use the Create() and Destroy() methods declared and implemented in the KFBXPLUGIN_DECLARE and KFBXPLUGIN_IMPLEMENT macros to construct and destroy KFbxPlugin objects.
KFbxPluginData &	GetData ()
	Accessor to the plug-in data.
const KFbxPluginData &	GetData () const
	const accessor to the plug-in data.

---

Constructor & Destructor Documentation

virtual ~KFbxPlugin

(

)

[virtual]

Destructor.

KFbxPlugin	(	const KFbxPluginDefinition &	pDefinition,
		kLibHandle	pLibHandle
	)			[explicit, protected]

Constructor Use the Create() and Destroy() methods declared and implemented in the KFBXPLUGIN_DECLARE and KFBXPLUGIN_IMPLEMENT macros to construct and destroy KFbxPlugin objects.

Parameters:

	pDefinition
	pLibHandle

---

Member Function Documentation

const KFbxPluginDefinition & GetDefinition

(

)

const [inline]

const accessor to the plug-in definition.

Plug-in definition contains basic information on the plug-in like its name or version.

Returns:

The definition for the current plug-in

Definition at line 222 of file kfbxplugin.h.

virtual void Destroy

(

)

[pure virtual]

Destructor.

KFbxObject& GetPluginSettings

(

)

[inline]

Destructor.

Definition at line 131 of file kfbxplugin.h.

const KFbxObject& GetPluginSettings

(

)

const [inline]

Destructor.

Definition at line 133 of file kfbxplugin.h.

KFbxPluginData & GetData

(

)

[inline, protected]

Accessor to the plug-in data.

Returns:

The data for the current plug-in

Definition at line 224 of file kfbxplugin.h.

const KFbxPluginData & GetData

(

)

const [inline, protected]

const accessor to the plug-in data.

Returns:

The const data for the current plug-in

Definition at line 226 of file kfbxplugin.h.

virtual bool SpecificInitialize

(

)

[pure virtual]

Method called after plug-in construction.

At that moment, plug-in data have been properly initialized. This is where the user implementation do their initialization routines

virtual bool SpecificTerminate

(

)

[pure virtual]

Method called before plug-in destruction.

This is where the user implementation do their uninitialization routines

virtual void WriteBegin

(

KFbxScene &

pScene

)

[inline, virtual]

Definition at line 180 of file kfbxplugin.h.

virtual void WriteParameters

(

KFbxObject &

pParams

)

[inline, virtual]

Definition at line 181 of file kfbxplugin.h.

virtual void WriteEnd

(

KFbxScene &

pScene

)

[inline, virtual]

Definition at line 182 of file kfbxplugin.h.

virtual void ReadBegin

(

KFbxScene &

pScene

)

[inline, virtual]

Definition at line 183 of file kfbxplugin.h.

virtual void ReadParameters

(

KFbxObject &

pParams

)

[inline, virtual]

Definition at line 184 of file kfbxplugin.h.

virtual void ReadEnd

(

KFbxScene &

pScene

)

[inline, virtual]

Definition at line 185 of file kfbxplugin.h.

KFbxEventHandler* Bind

(

void(ListernerType::*)(const EventType *)

pFunc

)

[inline]

Definition at line 191 of file kfbxplugin.h.

kLibHandle GetLibraryHandle

(

)

Retrieve module instance handle.

With the instance handle, someone can query proc addresses for example, allowing more complex interactions