KFbxPlugin
#include<kfbxplugin.h>

Inheritance diagram for KFbxPlugin:

Inheritance graph
[legend]

List of all members.

Detailed Description

Abstract class used to implement plug-ins.

Definition at line109of filekfbxplugin.h.


Public Member Functions

Public interface
constKFbxPluginDefinitionGetDefinition() const
 const accessor to the plug-in definition.
virtual void Destroy()=0
 const accessor to the plug-in definition.
KFbxObjectGetPluginSettings()
 const accessor to the plug-in definition.
constKFbxObjectGetPluginSettings() 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 *))

Protected Member Functions

 KFbxPlugin(constKFbxPluginDefinition&pDefinition)
 Constructor Use the Create() andDestroy()methods declared and implemented in the KFBXPLUGIN_DECLARE and KFBXPLUGIN_IMPLEMENT macros to construct and destroyKFbxPluginobjects.
KFbxPluginDataGetData()
 Accessor to the plug-in data.
constKFbxPluginDataGetData() const
 const accessor to the plug-in data.

Constructor&Destructor Documentation

KFbxPlugin(constKFbxPluginDefinitionpDefinition ) [explicit, protected]

Constructor Use the Create() andDestroy()methods declared and implemented in the KFBXPLUGIN_DECLARE and KFBXPLUGIN_IMPLEMENT macros to construct and destroyKFbxPluginobjects.

Parameters:
pDefinition 

Member Function Documentation

constKFbxPluginDefinition&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 line213of filekfbxplugin.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 line126of filekfbxplugin.h.

constKFbxObject&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 line128of filekfbxplugin.h.

KFbxPluginData&GetData( ) [inline, protected]

Accessor to the plug-in data.

Returns:
The data for the current plug-in

Definition at line215of filekfbxplugin.h.

constKFbxPluginData&GetData( ) const[inline, protected]

const accessor to the plug-in data.

Returns:
The const data for the current plug-in

Definition at line217of filekfbxplugin.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