FBX C++ API Reference
FbxPeripheral Class Referenceabstract

#include <fbxperipheral.h>

Class Description

FbxPeripheral is an interface to load/unload content of FbxObject from memory to somewhere you defined, for example, to a temporary file on disk .

You need to inherited your own peripheral class from this class and overload the functions to control what information of a FbxObject you want to load/unload, and where you are going to load/unload these information to. For example, you can ask an object to dump itself on disk to free some memory and vice-versa when you want to load/unload this object from your scene flexibly.

Definition at line 31 of file fbxperipheral.h.

Public Member Functions

virtual void Reset ()=0
 Reset the peripheral to its initial state. More...
 
virtual bool UnloadContentOf (FbxObject *pObject)=0
 Unload the content of pObject. More...
 
virtual bool LoadContentOf (FbxObject *pObject)=0
 Load the content of pObject. More...
 
virtual bool CanUnloadContentOf (FbxObject *pObject)=0
 Check if this peripheral can unload the given object content. More...
 
virtual bool CanLoadContentOf (FbxObject *pObject)=0
 Check if this peripheral can load the given object content. More...
 
virtual void InitializeConnectionsOf (FbxObject *pObject)=0
 Initialize the connections of an object. More...
 
virtual void UninitializeConnectionsOf (FbxObject *pObject)=0
 Uninitialize the connections of an object. More...
 

Constructor and Destructor

 FbxPeripheral ()
 Constructor. More...
 
virtual ~FbxPeripheral ()
 Destructor. More...
 

Constructor & Destructor Documentation

◆ FbxPeripheral()

Constructor.

◆ ~FbxPeripheral()

virtual ~FbxPeripheral ( )
virtual

Destructor.

Member Function Documentation

◆ Reset()

virtual void Reset ( )
pure virtual

Reset the peripheral to its initial state.

◆ UnloadContentOf()

virtual bool UnloadContentOf ( FbxObject pObject)
pure virtual

Unload the content of pObject.

Parameters
pObjectObject whose content is to be offloaded into the peripheral storage area.
Returns
true if the object content has been successfully transferred. false otherwise.

◆ LoadContentOf()

virtual bool LoadContentOf ( FbxObject pObject)
pure virtual

Load the content of pObject.

Parameters
pObjectObject whose content is to be loaded from the peripheral storage area.
Returns
true if the object content has been successfully transferred. false otherwise.

◆ CanUnloadContentOf()

virtual bool CanUnloadContentOf ( FbxObject pObject)
pure virtual

Check if this peripheral can unload the given object content.

Parameters
pObjectObject whose content has to be transferred.
Returns
true if the peripheral can handle this object content and has enough space in its storage area.false otherwise.

◆ CanLoadContentOf()

virtual bool CanLoadContentOf ( FbxObject pObject)
pure virtual

Check if this peripheral can load the given object content.

Parameters
pObjectObject whose content has to be transferred.
Returns
true if the peripheral can handle this object content. false otherwise.

◆ InitializeConnectionsOf()

virtual void InitializeConnectionsOf ( FbxObject pObject)
pure virtual

Initialize the connections of an object.

Parameters
pObjectObject on which the request for connection is done.

◆ UninitializeConnectionsOf()

virtual void UninitializeConnectionsOf ( FbxObject pObject)
pure virtual

Uninitialize the connections of an object.

Parameters
pObjectObject on which the request for disconnection is done.

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