FBAssetMng Class Reference

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

Inheritance diagram for FBAssetMng:

[legend]

List of all members.

---

Detailed Description

The FBAssetMng class.

Public Member Functions
	FBAssetMng (str pName)
	Constructor.
FBAssetFile	BrowseForFile ()
	Let the user browse the asset database to select a file.
FBAssetFolder	BrowseForFolder ()
	Let the user browse the asset database to select a folder.
bool	CheckAvailability ()
	Check if this manager can be used on the computer.
FBAssetFolder	CreateServerPath (str pServerPath)
	Create a folder path on the server side by adding each missing folders.
bool	FileIsManaged (str pFilename)
	Is the specified local file managed (ie.
FBAssetFile	GetAssetFile (str pServerFilename)
	Get a file object using it's server path.
FBAssetFile	GetAssetFileFromLocalPath (str pLocalFilename)
	Get a file object using it's local path.
FBAssetFolder	GetAssetFolder (str pServerPath)
	Get a folder object using it's server path.
FBAssetFolder	GetAssetFolderFromLocalPath (str pLocalPath)
	Get a folder object using it's local path.
int	GetFileOptions ()
	Get the file options (i.e.
bool	Initialize ()
	Initialize the connection to the server.
str	MapLocalPathToServerPath (str pLocalPath)
	Convert the local path to a server path by using managed paths mapping.
	ShowSettings ()
	Display a dialog that let the user changes settings.
bool	WithinManagedPath (str pLocalPath)
	Is the specified local path below a managed path.
Public Attributes
str	Description
	Read Write Property: Description of the manager.
str	LastError
	Last error string.
int	MenuFlags
	Read Write Property: Flags specifing which menu items are added by the manager.
str	Name
	Read Write Property: Unique Name.

---

Constructor & Destructor Documentation

FBAssetMng

(

str

pName

)

Constructor.

Parameters:

pName

Name of Command.

---

Member Function Documentation

FBAssetFile BrowseForFile

(

)

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.

FBAssetFolder BrowseForFolder

(

)

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

Returns:

A HFBAssetFolder object representing the folder that was selected, or NULL if none.

bool CheckAvailability

(

)

Check if this manager can be used on the computer.

FBAssetFolder CreateServerPath

(

str

pServerPath

)

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

Parameters:

pServerPath

The path to create on the server side.

Returns:

A HFBAssetFolder object representing the deepest folder of the path.

bool FileIsManaged

(

str

pFilename

)

Is the specified local file managed (ie.

also present in the database).

Parameters:

pFilename

Path to the file on the local disk.

Returns:

A boolean indicating if the file is managed or not.

FBAssetFile GetAssetFile

(

str

pServerFilename

)

Get a file object using it's server path.

Parameters:

pServerFilename

Path to the file on the server.

Returns:

An HFBAssetFile object, or NULL if the file was not found.

FBAssetFile GetAssetFileFromLocalPath

(

str

pLocalFilename

)

Get a file object using it's local path.

Parameters:

pLocalFilename

Path to the file on the local disk.

Returns:

An HFBAssetFile object, or NULL if the file was not found or no mapping could be done.

FBAssetFolder GetAssetFolder

(

str

pServerPath

)

Get a folder object using it's server path.

Parameters:

pServerPath

Path the the folder on the server.

Returns:

An HFBAssetFolder object, or NULL if the folder was not found.

FBAssetFolder GetAssetFolderFromLocalPath

(

str

pLocalPath

)

Get a folder object using it's local path.

Parameters:

pLocalPath

Path to the folder on the local disk.

Returns:

An HFBAssetFolder object, or NULL if the folder was not found or no mapping could be done.

int GetFileOptions

(

)

Get the file options (i.e.

what to do when loading, saving or closing managed files).

Returns:

The options.

bool Initialize

(

)

Initialize the connection to the server.

Returns:

True if the connection was established, false otherwise.

str MapLocalPathToServerPath

(

str

pLocalPath

)

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

Parameters:

pLocalPath

Local path to be mapped.

Returns:

A string with the resulting server path, will be empty if the mapping fail.

ShowSettings

(

)

Display a dialog that let the user changes settings.

bool WithinManagedPath

(

str

pLocalPath

)

Is the specified local path below a managed path.

Parameters:

pLocalPath

Local path to be checked.

Returns:

A boolean indicating if the path is within a managed path or not.

---

Member Data Documentation

str Description

Read Write Property: Description of the manager.

str LastError

Last error string.

int MenuFlags

Read Write Property: Flags specifing which menu items are added by the manager.

str Name

Read Write Property: Unique Name.

Reimplemented from FBComponent.

---