FbxLoadingStrategy Class Reference
 
 
 
FbxLoadingStrategy Class Reference

#include <fbxloadingstrategy.h>


Class Description

Abstract class used to implemented some plug-in loading strategy.

A loading strategy dictate how some plug-ins will be loaded for instance. We could have a simple strategy that loads only a single dll on PC. We could also implement a strategy that load multiple dlls from a directory.

Definition at line 31 of file fbxloadingstrategy.h.

Inheritance diagram for FbxLoadingStrategy:
FbxPluginContainer FbxEmitter FbxScopedLoadingDirectory FbxScopedLoadingFileName

List of all members.

Public Types

enum   EState { eAllLoaded, eNoneLoaded, eAllFailed, eSomeFailed }
  Result state of loading plug-in. More...

Public Member Functions

Public interface
EState  Load (FbxPluginData &pData)
  Execute the operation of loading the plug-in(s).
void  Unload ()
  Execute the operation of unloading the plug-in(s).

Protected Member Functions

User implementation
virtual bool  SpecificLoad (FbxPluginData &pData)=0
  Called by the Load method, it contains the specific user implementation strategy to load the desired plug-in(s).
virtual void  SpecificUnload (FbxPluginData &pData)=0
  Called by the Unload method, it contains the specific user implementation strategy to unload the desired plug-in(s).

Protected Attributes

EState  mPluginsLoadedState
  Whether the plugin is loaded or not.

Member Enumeration Documentation

enum EState

Result state of loading plug-in.

Enumerator:
eAllLoaded 

All plug-in are loaded.

eNoneLoaded 

No plug-in is loaded, i.e., there is not plug-in to load.

eAllFailed 

All plug-in are failed to load.

eSomeFailed 

Some plug-ins are loaded but some are failed.

Definition at line 36 of file fbxloadingstrategy.h.


Member Function Documentation

EState Load ( FbxPluginData pData )

Execute the operation of loading the plug-in(s).

The way it is executed is determined by the specific implementations.

Parameters:
pData Plug in data that can be access inside the plug-ins.
Returns:
If the plugin loading is successful return true, otherwise return false.
void Unload ( )

Execute the operation of unloading the plug-in(s).

The way it is executed is determined by the specific implementations.

virtual bool SpecificLoad ( FbxPluginData pData ) [protected, pure virtual]

Called by the Load method, it contains the specific user implementation strategy to load the desired plug-in(s).

Parameters:
pData Plug in data that can be access inside the plug-ins.
Returns:
If the plugin loading is successful return true, otherwise return false
virtual void SpecificUnload ( FbxPluginData pData ) [protected, pure virtual]

Called by the Unload method, it contains the specific user implementation strategy to unload the desired plug-in(s).


Member Data Documentation

Whether the plugin is loaded or not.

Definition at line 76 of file fbxloadingstrategy.h.


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