Detailed Description
Manages registration and ownership of FBX SDK plug-ins (FbxPlugin).
The FBX SDK will provide a pointer to KFbxPluginContainer as an argument to the FBXPluginRegistration() function exported from a plug-in's DLL. A plug-in must register itself explicitly with the KFbxPluginContainer by calling KFbxPluginContainer::Register() after it is constructed. For an example of this process see the code example in the KFbxPlugin class documentation.
- See also:
- KFbxPlugin
Definition at line 57 of file kfbxplugincontainer.h.
#include <kfbxplugincontainer.h>
Public Types |
|
| typedef
KIntrusiveList < KFbxPlugin > |
PluginList |
| Definition of a plug-in list. |
|
Public Member Functions |
|
| void | Register (KFbxPlugin &pPlugin) |
| The registration function that must be
called when the module containing the plug-in is loaded. |
|
| void | Unregister (KFbxPlugin &pPlugin) |
| The unregistration function that must be
called when the module containing the plug-in is unloaded. |
|
| const PluginList & | GetPlugins () const |
| Const accessor to the list of plug-ins owned
by the container. |
|
| PluginList & | GetPlugins () |
| Accessor to the list of plug-ins owned by
the container. |
|
Protected Member Functions |
|
| virtual | ~KFbxPluginContainer () |
Protected Attributes |
|
| PluginList | mPlugins |
Member Typedef Documentation
| typedef KIntrusiveList<KFbxPlugin> PluginList |
Definition of a plug-in list.
Definition at line 71 of file kfbxplugincontainer.h.
Constructor & Destructor Documentation
| virtual ~KFbxPluginContainer | ( | ) | [protected, virtual] |
Member Function Documentation
| void Register | ( | KFbxPlugin & | pPlugin | ) |
The registration function that must be called when the module containing the plug-in is loaded.
- Parameters:
-
pPlugin The plug-in to register.
| void Unregister | ( | KFbxPlugin & | pPlugin | ) |
The unregistration function that must be called when the module containing the plug-in is unloaded.
- Parameters:
-
pPlugin The plug-in to unregister.
| const PluginList& GetPlugins | ( | ) | const |
Const accessor to the list of plug-ins owned by the container.
- Returns:
- A list of plug-in registered to this container.
| PluginList& GetPlugins | ( | ) |
Accessor to the list of plug-ins owned by the container.
- Returns:
- A list of plug-in registered to this container.
Member Data Documentation
PluginList
mPlugins [protected] |
Definition at line 94 of file kfbxplugincontainer.h.
The documentation for this class was generated from the following file:
- fbxfilesdk/kfbxmodules/kfbxplugincontainer.h
