FbxPluginContainer Class Reference
 
 
 
FbxPluginContainer Class Reference

This reference page is linked to from the following overview topics: Customizing File Formats with FBX SDK I/O Plug-ins.


#include <fbxplugincontainer.h>


Class 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.

Inheritance diagram for FbxPluginContainer:
FbxEmitter FbxLoadingStrategy FbxScopedLoadingDirectory FbxScopedLoadingFileName

List of all members.

Public Types

typedef FbxIntrusiveList
< FbxPlugin
PluginList
  Definition of a plug-in list.

Public Member Functions

void  Register (FbxPlugin &pPlugin)
  The registration function that must be called when the module containing the plug-in is loaded.
void  Unregister (FbxPlugin &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.

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:
pPlugin The 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:
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.

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