Used to access asset manager functionity to get files locally or from a server.
Definition at line 431 of file fbassetmng.h.
#include <fbassetmng.h>
Public Member Functions | |
FBAssetMng (const char *pName, HIObject pObject=NULL) | |
Constructor. | |
IObject_Declare (K_IMPLEMENTATION) | |
virtual bool | Initialize ()=0 |
Initialize the connection to the server. | |
virtual FBAssetFile * | BrowseForFile ()=0 |
Let the user browse the asset database to select a file. | |
virtual FBAssetFolder * | BrowseForFolder ()=0 |
Let the user browse the asset database to select a folder. | |
virtual FBAssetFolder * | CreateServerPath (const FBString &pServerPath)=0 |
Create a folder path on the server side by adding each missing folders. | |
virtual bool | FileIsManaged (const FBString &pFilename)=0 |
Is the specified local file managed (ie. | |
virtual bool | WithinManagedPath (const FBString &pLocalPath)=0 |
Is the specified local path below a managed path. | |
virtual FBString | MapLocalPathToServerPath (const FBString &pLocalPath)=0 |
Convert the local path to a server path by using managed paths mapping. | |
virtual FBAssetFile * | GetAssetFile (const FBString &pServerFilename)=0 |
Get a file object using it's server path. | |
virtual FBAssetFile * | GetAssetFileFromLocalPath (const FBString &pLocalFilename)=0 |
Get a file object using it's local path. | |
virtual FBAssetFolder * | GetAssetFolder (const FBString &pServerPath)=0 |
Get a folder object using it's server path. | |
virtual FBAssetFolder * | GetAssetFolderFromLocalPath (const FBString &pLocalPath)=0 |
Get a folder object using it's local path. | |
virtual void | ShowSettings ()=0 |
Display a dialog that let the user changes settings. | |
virtual int | GetFileOptions ()=0 |
Get the file options (i.e. | |
virtual bool | CheckAvailability () const =0 |
Check if this manager can be used on the computer. | |
Public Attributes | |
FBPropertyString | Name |
Read Write Property: Unique Name. | |
FBPropertyString | Description |
Read Write Property: Description of the manager. | |
FBPropertyInt | MenuFlags |
Read Write Property: Flags specifing which menu items are added by the manager. | |
FBString | LastError |
Last error string. |
FBAssetMng | ( | const char * | pName, |
HIObject | pObject = NULL |
||
) |
Constructor.
pName | Name of Command. |
pObject | Internal parent object to own FBComponent (default is NULL). |
IObject_Declare | ( | K_IMPLEMENTATION | ) |
Reimplemented from FBComponent.
virtual bool Initialize | ( | ) | [pure virtual] |
Initialize the connection to the server.
virtual FBAssetFile* BrowseForFile | ( | ) | [pure virtual] |
Let the user browse the asset database to select a file.
virtual FBAssetFolder* BrowseForFolder | ( | ) | [pure virtual] |
Let the user browse the asset database to select a folder.
virtual FBAssetFolder* CreateServerPath | ( | const FBString & | pServerPath | ) | [pure virtual] |
Create a folder path on the server side by adding each missing folders.
pServerPath | The path to create on the server side. |
virtual bool FileIsManaged | ( | const FBString & | pFilename | ) | [pure virtual] |
Is the specified local file managed (ie.
also present in the database).
pFilename | Path to the file on the local disk. |
virtual bool WithinManagedPath | ( | const FBString & | pLocalPath | ) | [pure virtual] |
Is the specified local path below a managed path.
pLocalPath | Local path to be checked. |
Convert the local path to a server path by using managed paths mapping.
pLocalPath | Local path to be mapped. |
virtual FBAssetFile* GetAssetFile | ( | const FBString & | pServerFilename | ) | [pure virtual] |
Get a file object using it's server path.
pServerFilename | Path to the file on the server. |
virtual FBAssetFile* GetAssetFileFromLocalPath | ( | const FBString & | pLocalFilename | ) | [pure virtual] |
Get a file object using it's local path.
pLocalFilename | Path to the file on the local disk. |
virtual FBAssetFolder* GetAssetFolder | ( | const FBString & | pServerPath | ) | [pure virtual] |
Get a folder object using it's server path.
pServerPath | Path the the folder on the server. |
virtual FBAssetFolder* GetAssetFolderFromLocalPath | ( | const FBString & | pLocalPath | ) | [pure virtual] |
Get a folder object using it's local path.
pLocalPath | Path to the folder on the local disk. |
virtual void ShowSettings | ( | ) | [pure virtual] |
Display a dialog that let the user changes settings.
virtual int GetFileOptions | ( | ) | [pure virtual] |
Get the file options (i.e.
what to do when loading, saving or closing managed files).
virtual bool CheckAvailability | ( | ) | const [pure virtual] |
Check if this manager can be used on the computer.
Read Write Property: Unique Name.
Reimplemented from FBComponent.
Definition at line 518 of file fbassetmng.h.
Read Write Property: Description of the manager.
Definition at line 519 of file fbassetmng.h.
Read Write Property: Flags specifing which menu items are added by the manager.
Definition at line 520 of file fbassetmng.h.