FBX C++ API Reference
FbxPluginContainer Class Reference

Manages registration and ownership of FBX SDK plug-ins (FbxPlugin). More...

#include <fbxplugincontainer.h>

+ Inheritance diagram for FbxPluginContainer:

Public Types

typedef FbxIntrusiveList< FbxPluginPluginList
 Definition of a plug-in list. More...
 

Public Member Functions

void Register (FbxPlugin &pPlugin)
 The registration function that must be called when the module containing the plug-in is loaded. More...
 
void Unregister (FbxPlugin &pPlugin)
 The unregistration function that must be called when the module containing the plug-in is unloaded. More...
 
const PluginListGetPlugins () const
 Const accessor to the list of plug-ins owned by the container. More...
 
PluginListGetPlugins ()
 Accessor to the list of plug-ins owned by the container. More...
 
- Public Member Functions inherited from FbxEmitter
void AddListener (FbxEventHandler &pHandler)
 Add the specified event handler to current emitter list. More...
 
void RemoveListener (FbxEventHandler &pHandler)
 Remove the specified event handler from current emitter list. More...
 
template<typename EventType >
void Emit (const EventType &pEvent) const
 Emit an event with the specified the event type. More...
 

Detailed Description

Manages registration and ownership of FBX SDK plug-ins (FbxPlugin).

The FBX SDK will provide a pointer to FbxPluginContainer as an argument to the FBXPluginRegistration() function exported from a plug-in's DLL. A plug-in must register itself explicitly with the FbxPluginContainer by calling FbxPluginContainer::Register() after it is constructed. For an example of this process see the code example in the FbxPlugin class documentation.

See also
FbxPlugin

Definition at line 34 of file fbxplugincontainer.h.

Member Typedef Documentation

typedef FbxIntrusiveList<FbxPlugin> PluginList

Definition of a plug-in list.

Definition at line 38 of file fbxplugincontainer.h.

Member Function Documentation

void Register ( FbxPlugin pPlugin)

The registration function that must be called when the module containing the plug-in is loaded.

Parameters
pPluginThe plug-in to register.
void Unregister ( FbxPlugin pPlugin)

The unregistration function that must be called when the module containing the plug-in is unloaded.

Parameters
pPluginThe 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.

The documentation for this class was generated from the following file: