FBAssetFolder Class Reference

Class representing a folder stored in a version control database. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBAssetFolder:

Public Member Functions
	FBAssetFolder (str pName)
	Constructor.
FBAssetFile	AddFile (str pLocalPath, str pComment="", bool pCheckOut=False, bool pSilent=False)
	Add a specified file into the database.
FBAssetFolder	AddFolder (str pName, str pComment="", bool pSilent=False)
	Add a folder in the database.
bool	FBCreate ()
	Open Reality Creation function.
FBAssetItem	GetChild (int pIndex)
	Get the child at index pIndex.
int	GetChildCount ()
	Get the number of items in this folder.
FBAssetFile	GetFile (str pName)
	Get a file present in this folder by using it's name.
FBAssetFolder	GetFolder (str pName)
	Get a folder present in this folder by using it's name.
Public Member Functions inherited from FBAssetItem
	FBAssetItem (str pName)
	Constructor.
bool	CheckIn (str pComment="", bool pKeepCheckedOut=False, bool pSilent=False)
	Checks in this item and all its children (if this is a folder item).
bool	CheckOut (str pComment="", bool pDontGetLocal=False, bool pSilent=False)
	Checks out this item and it's childs (if this is a folder item) and makes them writeable on the local disk.
bool	GetLatest (bool pReplaceCheckedOut=False, bool pSilent=False)
	Obtain the latest version of the item from the server.
str	GetLocalPath ()
	Get the path to this item on the local hard disk.
str	GetName ()
	Get the name of this item (file name or folder name).
FBAssetFolder	GetParent ()
	Get the parent folder of this item.
str	GetServerPath ()
	Get the path to this item on the database.
	ShowHistory ()
	Display a dialog with this item history.
	ShowProperties ()
	Display a dialog showing the properties of this item.
bool	UndoCheckOut (bool pReplaceLocalFile=True, bool pSilent=False)
	Cancel the last check out operation.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Additional Inherited Members
Public Attributes inherited from FBAssetItem
str	LastError
	Last error string.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Class representing a folder stored in a version control database.

Constructor & Destructor Documentation

FBAssetFolder()

FBAssetFolder

(

str

pName

)

Constructor.

Parameters

pName

Name of Command.

Member Function Documentation

AddFile()

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

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 FBAssetfile* object representing the newly added file.

AddFolder()

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

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 FBAssetFolder* object representing the newly added folder.

FBCreate()

bool FBCreate

(

)

Open Reality Creation function.

Returns

Outcome of creation (true/false).

GetChild()

FBAssetItem GetChild

(

int

pIndex

)

Get the child at index pIndex.

Returns

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

GetChildCount()

int GetChildCount

(

)

Get the number of items in this folder.

Returns

The number of items in this folder.

GetFile()

FBAssetFile GetFile

(

str

pName

)

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.

GetFolder()

FBAssetFolder GetFolder

(

str

pName

)

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.