Detailed Description
Custom manager class for user controlled observer objects.
This class is used to create a singleton object that has a lifetime similar to the one of the application. Meaning that it is created early in the initialization of the application and survives across File->Open and File->New, being destroyed upon shutdown of the application.
The manager object is notified by the application at certain points in time, such as when the scene is cleared or the application is shutting down.
Manager objects are not saved or mentionned in the FBX files created. Its behavior can be controlled via custom configuration files.
Definition at line 1055 of file fbcomponent.h.
#include <fbcomponent.h>
Public Types |
|
| typedef FBComponent | __FBParentClass |
| typedef FBCustomManager | __FBClassType |
Public Member Functions |
|
| virtual char * | ClassName () override |
| Get the class name. |
|
| virtual bool | Is (int pTypeId) override |
| Returns true if object is of type TypeId.
|
|
| virtual int | GetTypeId () override |
| GetTypeId( int pTypeId ) |
|
| virtual | ~FBCustomManager () |
| FBCustomManager () | |
| Constructor. |
|
| void | RegisterManager () |
| Instantiating the manager is not enough.
|
|
| virtual bool | FBCreate () |
| Open Reality Creation function. |
|
| virtual bool | Init () |
| This method is called upon the loading of
the plugin, right after FBCreate is called. |
|
| virtual bool | Open () |
| Now all the basic initialization is done,
but we have yet to load any FBX files or even create the GUI.
|
|
| virtual bool | Clear () |
| This callback is used when the scene is
cleared. |
|
| virtual bool | Close () |
| The application is shutting down. |
|
Static Public Member Functions |
|
| static int | GetInternalClassId () |
Public Attributes |
|
| DataFBCustomManager * | mLocalPtr |
| Handle on HDataFBComponent. |
|
Static Public Attributes |
|
| static int | TypeInfo |
| Contains the Type information of the object.
|
|
Member Typedef Documentation
| typedef FBComponent __FBParentClass |
Definition at line 1056 of file fbcomponent.h.
| typedef FBCustomManager __FBClassType |
Definition at line 1056 of file fbcomponent.h.
Constructor & Destructor Documentation
| virtual ~FBCustomManager | ( | ) | [virtual] |
| FBCustomManager | ( | ) |
Constructor.
Member Function Documentation
| virtual char* ClassName | ( | ) | [inline, override, virtual] |
Get the class name.
- Returns:
- The class name (i.e. "FBComponent").
Reimplemented from FBComponent.
Definition at line 1056 of file fbcomponent.h.
: public FBComponent {
| virtual bool Is | ( | int | pTypeId | ) | [inline, override, virtual] |
Returns true if object is of type TypeId.
- Parameters:
-
pTypeId TypeId to compare object to.
- Returns:
- Result of the comparison.
Reimplemented from FBComponent.
Definition at line 1056 of file fbcomponent.h.
: public FBComponent {
| virtual int GetTypeId | ( | ) | [inline, override, virtual] |
GetTypeId( int pTypeId )
- Returns:
- The TypeInfo of the object
Reimplemented from FBComponent.
Definition at line 1056 of file fbcomponent.h.
: public FBComponent {
| static int GetInternalClassId | ( | ) | [static] |
| void RegisterManager | ( | ) |
Instantiating the manager is not enough.
It also need to be registered in the list of all managers. This call is done automatically via the use of the macro 'FBRegisterCustomManager'.
| virtual bool FBCreate | ( | ) | [virtual] |
Open Reality Creation function.
- Returns:
- Outcome of creation (true/false).
Reimplemented from FBComponent.
| virtual bool Init | ( | ) | [virtual] |
This method is called upon the loading of the plugin, right after FBCreate is called.
Since it happens very early in the lifespan of the application, not all the initialization is done. So access to system objects is very limited.
| virtual bool Open | ( | ) | [virtual] |
Now all the basic initialization is done, but we have yet to load any FBX files or even create the GUI.
/warning if Init does not return true, the 'Close()' method will not be called.
| virtual bool Clear | ( | ) | [virtual] |
This callback is used when the scene is cleared.
This may be from a new file being loaded (not appended to the current one), a File->New or the application being shutdown.
| virtual bool Close | ( | ) | [virtual] |
The application is shutting down.
Time to cleanup anything that references system resources.
Member Data Documentation
| DataFBCustomManager* mLocalPtr |
Handle on HDataFBComponent.
Reimplemented from FBComponent.
Definition at line 1056 of file fbcomponent.h.
int TypeInfo
[static] |
Contains the Type information of the object.
Reimplemented from FBComponent.
Definition at line 1056 of file fbcomponent.h.
The documentation for this class was generated from the following file:
- fbsdk/fbcomponent.h
