Public Member Functions | Public Attributes

FBAssetMng Class Reference

Search for all occurrences

Detailed Description

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>

Inheritance diagram for FBAssetMng:
Inheritance graph
[legend]

List of all members.

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 FBAssetFileBrowseForFile ()=0
 Let the user browse the asset database to select a file.
virtual FBAssetFolderBrowseForFolder ()=0
 Let the user browse the asset database to select a folder.
virtual FBAssetFolderCreateServerPath (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 FBAssetFileGetAssetFile (const FBString &pServerFilename)=0
 Get a file object using it's server path.
virtual FBAssetFileGetAssetFileFromLocalPath (const FBString &pLocalFilename)=0
 Get a file object using it's local path.
virtual FBAssetFolderGetAssetFolder (const FBString &pServerPath)=0
 Get a folder object using it's server path.
virtual FBAssetFolderGetAssetFolderFromLocalPath (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.

Constructor & Destructor Documentation

FBAssetMng ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of Command.
pObjectInternal parent object to own FBComponent (default is NULL).

Member Function Documentation

IObject_Declare ( K_IMPLEMENTATION  )
virtual bool Initialize ( ) [pure virtual]

Initialize the connection to the server.

Returns:
True if the connection was established, false otherwise.
virtual FBAssetFile* BrowseForFile ( ) [pure virtual]

Let the user browse the asset database to select a file.

Returns:
A file object representing the file that was selected, or NULL if none.
virtual FBAssetFolder* BrowseForFolder ( ) [pure virtual]

Let the user browse the asset database to select a folder.

Returns:
A FBAssetFolder* object representing the folder that was selected, or NULL if none.
virtual FBAssetFolder* CreateServerPath ( const FBString pServerPath) [pure virtual]

Create a folder path on the server side by adding each missing folders.

Parameters:
pServerPathThe path to create on the server side.
Returns:
A FBAssetFolder* object representing the deepest folder of the path.
virtual bool FileIsManaged ( const FBString pFilename) [pure virtual]

Is the specified local file managed (ie.

also present in the database).

Parameters:
pFilenamePath to the file on the local disk.
Returns:
A boolean indicating if the file is managed or not.
virtual bool WithinManagedPath ( const FBString pLocalPath) [pure virtual]

Is the specified local path below a managed path.

Parameters:
pLocalPathLocal path to be checked.
Returns:
A boolean indicating if the path is within a managed path or not.
virtual FBString MapLocalPathToServerPath ( const FBString pLocalPath) [pure virtual]

Convert the local path to a server path by using managed paths mapping.

Parameters:
pLocalPathLocal path to be mapped.
Returns:
A string with the resulting server path, will be empty if the mapping fail.
virtual FBAssetFile* GetAssetFile ( const FBString pServerFilename) [pure virtual]

Get a file object using it's server path.

Parameters:
pServerFilenamePath to the file on the server.
Returns:
An FBAssetFile* object, or NULL if the file was not found.
virtual FBAssetFile* GetAssetFileFromLocalPath ( const FBString pLocalFilename) [pure virtual]

Get a file object using it's local path.

Parameters:
pLocalFilenamePath to the file on the local disk.
Returns:
An FBAssetFile* object, or NULL if the file was not found or no mapping could be done.
virtual FBAssetFolder* GetAssetFolder ( const FBString pServerPath) [pure virtual]

Get a folder object using it's server path.

Parameters:
pServerPathPath the the folder on the server.
Returns:
An FBAssetFolder* object, or NULL if the folder was not found.
virtual FBAssetFolder* GetAssetFolderFromLocalPath ( const FBString pLocalPath) [pure virtual]

Get a folder object using it's local path.

Parameters:
pLocalPathPath to the folder on the local disk.
Returns:
An FBAssetFolder* object, or NULL if the folder was not found or no mapping could be done.
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).

Returns:
The options.
virtual bool CheckAvailability ( ) const [pure virtual]

Check if this manager can be used on the computer.


Member Data Documentation

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.

Last error string.

Definition at line 521 of file fbassetmng.h.


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

FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng
FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng FBAssetMng