KFbxPlugin Class Reference
#include
<kfbxplugin.h>
Detailed Description
Abstract class used to implement plug-ins.Definition at line 109 of file kfbxplugin.h.
Public Member Functions |
|
|
Public interface
|
|
| const KFbxPluginDefinition & | GetDefinition () const |
| const accessor to the plug-in definition.
|
|
| virtual void | Destroy ()=0 |
| const accessor to the plug-in definition.
|
|
| KFbxObject & | GetPluginSettings () |
| const accessor to the plug-in definition.
|
|
| const KFbxObject & | GetPluginSettings () const |
| const accessor to the plug-in definition.
|
|
|
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
| 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 217 of file kfbxplugin.h.
| virtual void Destroy | ( | ) | [pure virtual] |
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
| KFbxObject& GetPluginSettings | ( | ) | [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 126 of file kfbxplugin.h.
| const KFbxObject& GetPluginSettings | ( | ) | 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 128 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 219 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 221 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
| kLibHandle GetLibraryHandle | ( | ) |
Retrieve module instance handle.
With the instance handle, someone can query proc addresses for example, allowing more complex interactions