FBAssetFolder Class Reference

Search for all occurrences

---

Detailed Description

Class representing a folder stored in a version control database.

Inheritance diagram for FBAssetFolder:

List of all members.

Public Member Functions
	__init__ (str pName, object pObject=None)
	Constructor.
	IObject_Declare (Implementation)
bool	FBCreate ()
	Open Reality Creation function.
int	GetChildCount ()
	Get the number of items in this folder.
HFBAssetItem	GetChild (int pIndex)
	Get the child at index pIndex.
HFBAssetFile	GetFile (str pName)
	Get a file present in this folder by using it's name.
HFBAssetFolder	GetFolder (str pName)
	Get a folder present in this folder by using it's name.
HFBAssetFile	AddFile (str pLocalPath, str pComment="", bool pCheckOut=False, bool pSilent=False)
	Add a specified file into the database.
HFBAssetFolder	AddFolder (str pName, str pComment="", bool pSilent=False)
	Add a folder in the database.

---

Member Function Documentation

__init__	(	str	pName,
		object	pObject = None
	)

Search for all occurrences

Constructor.

Parameters:

pName	Name of Command.
pObject	Internal parent object to own FBComponent (default is NULL).

Reimplemented from FBAssetItem.

IObject_Declare

(

Implementation

)

Search for all occurrences

Reimplemented from FBComponent.

bool FBCreate

(

)

Search for all occurrences

Open Reality Creation function.

Returns:

Outcome of creation (true/false).

Reimplemented from FBComponent.

int GetChildCount

(

)

Search for all occurrences

Get the number of items in this folder.

Returns:

The number of items in this folder.

HFBAssetItem GetChild

(

int

pIndex

)

Search for all occurrences

Get the child at index pIndex.

Returns:

The child at pIndex, or NULL if the index was out of range.

HFBAssetFile GetFile

(

str

pName

)

Search for all occurrences

Get a file present in this folder by using it's name.

Returns:

The file with the given name, or NULL if it was not found.

HFBAssetFolder GetFolder

(

str

pName

)

Search for all occurrences

Get a folder present in this folder by using it's name.

Returns:

The folder with the given name, or NULL if it was not found.

HFBAssetFile AddFile	(	str	pLocalPath,
		str	pComment = "",
		bool	pCheckOut = False,
		bool	pSilent = False
	)

Search for all occurrences

Add a specified file into the database.

It will be added in this folder.

Parameters:

pLocalPath	The full path to the file on the local disk.
pComment	Comment to be applied for the operation.
pCheckOut	Whether the file should be checked out or not.
pSilent	If pSilent is set to true, no dialog will be displayed by this method.

Returns:

An HFBAssetfile object representing the newly added file.

HFBAssetFolder AddFolder	(	str	pName,
		str	pComment = "",
		bool	pSilent = False
	)

Search for all occurrences

Add a folder in the database.

It will be added in this folder.

Parameters:

pName	Name of the folder to be created.
pComment	Comment to be applied for the operation.
pSilent	If pSilent is set to true, no dialog will be displayed by this method.

Returns:

An HFBAssetFolder object representing the newly added folder.