KFbxPeripheral Class Reference

#include <kfbxperipheral.h>

List of all members.

---

Detailed Description

KFbxPeripheral is an interface to load/unload content of KFbxObject 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 KFbxObject 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 57 of file kfbxperipheral.h.

Constructor and Destructor
	KFbxPeripheral ()
	Constructor.
virtual	~KFbxPeripheral ()
	Destructor.
Public Member Functions
virtual void	Reset ()=0
	Reset the peripheral to its initial state.
virtual bool	UnloadContentOf (KFbxObject *pObject)=0
	Unload the content of pObject.
virtual bool	LoadContentOf (KFbxObject *pObject)=0
	Load the content of pObject.
virtual bool	CanUnloadContentOf (KFbxObject *pObject)=0
	Check if this peripheral can unload the given object content.
virtual bool	CanLoadContentOf (KFbxObject *pObject)=0
	Check if this peripheral can load the given object content.
virtual void	InitializeConnectionsOf (KFbxObject *pObject)=0
	Initialize the connections of an object.
virtual void	UninitializeConnectionsOf (KFbxObject *pObject)=0
	Uninitialize the connections of an object.

---

Constructor & Destructor Documentation

KFbxPeripheral

(

)

Constructor.

virtual ~KFbxPeripheral

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void Reset

(

)

[pure virtual]

Reset the peripheral to its initial state.

virtual bool UnloadContentOf

(

KFbxObject *

pObject

)

[pure virtual]

Unload the content of pObject.

Parameters:

pObject

Object whose content is to be offloaded into the peripheral storage area.

Returns:

true if the object content has been successfully transferred. false otherwise.

virtual bool LoadContentOf

(

KFbxObject *

pObject

)

[pure virtual]

Load the content of pObject.

Parameters:

pObject

Object whose content is to be loaded from the peripheral storage area.

Returns:

true if the object content has been successfully transferred. false otherwise.

virtual bool CanUnloadContentOf

(

KFbxObject *

pObject

)

[pure virtual]

Check if this peripheral can unload the given object content.

Parameters:

pObject

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

virtual bool CanLoadContentOf

(

KFbxObject *

pObject

)

[pure virtual]

Check if this peripheral can load the given object content.

Parameters:

pObject

Object whose content has to be transferred.

Returns:

true if the peripheral can handle this object content. false otherwise.

virtual void InitializeConnectionsOf

(

KFbxObject *

pObject

)

[pure virtual]

Initialize the connections of an object.

Parameters:

pObject

Object on which the request for connection is done.

virtual void UninitializeConnectionsOf

(

KFbxObject *

pObject

)

[pure virtual]

Uninitialize the connections of an object.

Parameters:

pObject

Object on which the request for disconnection is done.